The Chart Display Advanced™ web part displays data returned
from SharePoint lists as a graphic chart that represents the data calculated
from the lists. The data provided by the chart roll-ups may come from one site,
multiple sites, selected sites, or portal sub-areas. Charts may be implemented
anywhere while still pointing to the data. Chart images can be viewed on a
site, saved locally to a hard drive, or uploaded to other sites. You can even place the chart on an external
web site and it will still dynamically update.
Users who have access to this web part can create their own
charts representing the data they wish to see without requiring assistance from
a Site Administrator. Many properties are available to change the look and feel
for the charting of the data returned.
Last Modified: DATE \@ "MMMM yy" January 07
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Administration Window
(Pre-Summer 2005 Only)” instead.
As of the Summer 05 release, the
administration interface includes a Sites and Lists tab that is used to select
the sites, portals, and/or sub-areas and lists to include in the user
presentation of the roll-up. You can select any number of lists or libraries
from any number of sites on the server that the web part is running on as the
source for the roll-up.
When you are finished making your selections
on this tab, make sure you click Apply to save your changes and keep the
administration interface open, or click OK to save your changes and return to
the roll-up display. Other tabs do not require you to click Apply to save
changes; changes are saved automatically when you move from one tab to another.
However, this tab differs in that clicking Apply loads your schema selections
and other settings referenced by other tabs.
This field is used to specify how the web
part should identify the sites and lists to include in the roll-up display.
· Selective allows you to select each
specific list that you want to include.
· Line of Site enables you to identify a
URL and the number of levels below that URL to include in the display. Any sites
that exist now or are created in the future within the specified number of
levels will be automatically recognized and included in the roll-up display. If
you choose Line of Site, the page refreshes and the "List Selection
Settings" section is removed from the display.
Did
you know… With Selective roll-ups, you can reference a list to which your
users have read access in a site to which they do not have access. This
is because Selective roll-ups hard-code the URL of the site and list, and do
not check to see if the user has access to the entire site, as Line of Site
roll-ups do.
This optional field is used to define the
URL for the site (or the top-level site) you want to access and from which you
want to return list items. This can be any SharePoint site that resides on the same
server as this web part. If this field is left blank, it will default to the
URL where the roll-up web part is placed.
The format for the URL is http://Site-URL/SiteName.
Examples:
· http://www.sitename.com/
· http://www.sitename.com/site1
· http://www.sitename.com/site1/site1a
To include lists from more than one site, type
the first URL you want to work with in the Site URL field and then click Add
URL. The URL you just identified is placed in the box below the field. Type
another URL in the Site URL field and click Add URL again. Repeat this process
as many times as necessary.
To remove selected URLs from this area,
highlight the URL you want to remove from the box below this field and click
Remove. Alternatively, you can click Remove All to remove all URLs.
TIP 1:
If the site that contains the lists you want to work with is displayed by the
Workplace View Advanced web part, you can right-click on the site, select Copy
Shortcut, and paste the URL in the Site URL field.
TIP
2: If you configure a roll-up as Line of Site and a user does not have
rights to access a particular site, that site and any sites under that
site will not be included in the roll-up. This is true even if the user does
have rights to a site that’s below the site to which they do not have access.
If you want the roll-up to include the site to which the user does have rights,
you can take advantage of the ability to identify multiple URLs in the Site URL
field and include the URL of the site to which they do have access.
This drop-down field lists all of the
available schemas that can be used with this web part. The default is “Utilize
All Schemas.” However, you can choose to include only those lists that utilize
a particular schema. This can be useful if you want to narrow your search to
those list templates that include the fields that you want to use.
Schemas contain the elements that identify a
list: the list type, filter and search fields, display fields, and so on. When
you select a schema, the elements of that schema will be used to find only
those lists that match that schema profile. Lists of schemas can be found in
the Supported Schemas
section of this web part help.
NOTE:
If you have created your own schemas, you will not be able to select them from
the Schemas drop-down for the out-of-the-box CorasWorks Chart roll-ups. You
will need to create your own version of the roll-up web part that references
your custom schema using the Roll-Up Wizard, which is available with the
Developer and Small Business editions of the Workplace Suite.
This optional field is used to define the
number of levels to search within a site to find lists for the roll-up display.
If this field is left blank, it will default to 0, which searches only the site
named in the Site URL field. The maximum recommended number of levels is 10.
Please make sure that a number is entered in
this field. If you spell out a number, it will result in an error and no lists
will be found.
If you have chosen the Selective return type
and you change the value identified in this field, click the “Refresh Available
Lists” option to the right of this field.
This updates the sites and lists identified in the Available Lists
drop-down field, described below.
This drop-down field displays the lists
available to be chosen for return by the web part. This includes all available
lists, even if they have already been selected and are displayed in the
"Currently Selected Lists" field. The format for the lists displayed here
is “Site Name | List Name.”
Click on a list to add it to your selection
for the web part display. Click "Select All Sites & Lists" to
include items from all of the available lists in the web part display.
This
area displays all of the lists you have selected to include in the
roll-up display. The format for the lists displayed in this field is “Site Name
| List Name.”
To remove a list, simply highlight the list
and it will be removed from the display. Select "Remove All Sites &
Lists" to remove all of the lists from the roll-up display.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
Filtering allows you to limit the items
returned by a roll-up to only those that meet the criteria you define. When a filter is performed, the roll-up looks
for text matches on the metadata returned by the roll-up. Users can further refine the results by
performing searches on a filtered roll-up. Note that filtering allows you to
locate data in a specific field, while searching locates data in any field in
the list.
There are two available views on the
Filtering tab:
· The
default view is referenced as the “Filter Builder.” It provides a series of builder fields that
make it easier for non-technical individuals to define filters because it is
not necessary to know the correct syntax; the fields prompt you for each
necessary piece of information.
· The
other view is referenced as “Advanced Filter Settings” and it allows you to
manually build a tab. You can use the Basic Filter field to define a filter, or
you can use the CAML Filter field to define a filter that utilizes CAML. Click here to
jump down to that section of the help.
This topic includes the following subjects:
· Defining a Filter with the Filter Builder
· Upgrading from Previous Versions
NOTE: To gain the best performance for filters, use the Filter Builder
to build your filters; do not use complex, basic, or the feature to
automatically convert basic filters to CAML. If a basic filter was used in a previous
release and you want to have it permanently converted to CAML, simply open the
Filter Builder and click
Apply or OK. This converts the basic filter to
CAML, loads the filter into the Filter Builder, and then saves the new CAML
filter and deletes the old basic filter.
When you first access the new Filtering tab,
the Filter Builder is displayed as shown in the figure above. Each component of the filter is comprised of
three fields:
· The first field presents a drop-down list of all of the
fields that are available for filtering.
Click to select the field you want to start building your filter with.
· The next field is used to select the desired operator
for the filter (is equal to, is less than, contains, etc.).
· The third field is used to identify the value you want
the filter to find. You can simply type
in the value you want to find, or you can use a function (see “Supported
Functions” below).
If you only want to filter on a single field
and a single value, all you need to do is click Apply or OK to save your
filter. When your filter is saved, it
will be converted to CAML automatically. This is done to help improve
performance.
NOTE:
Do not enter any CAML code in the Filter Builder. The Builder will automatically convert the
criteria to CAML for you. If you have criteria that is too complex to enter in
the Filter Builder, use the “Click to manually build a filter” link at the bottom of the tab and define
the filter in the CAML
Filter field.
The following values can be entered into the
third entry field for filters based on Boolean fields:
· True
· False
· Yes
· No
· 0 (translates to False)
· 1 (translates to True)
To filter on multiple fields and/or values,
you need to define additional filter components. The Filtering tab presents two
groups of criteria that can be used:
· The
group of fields on the top half of the tab are used to define the “and”
components of the filter. The roll-up will only display items that meet all
of the criteria entered here. (For example, Status is equal to In Progress AND
Priority is equal to High.)
· The
group of fields on the lower half of this tab allow you to define the “or”
components of the filter. The roll-up will display items that meet any
(one or more) of the criteria entered here. (For example, Status is equal to
Not Started OR Status is equal to On Hold.)
To define multiple filter components on
either the top or bottom half of the tab, click the “Add More Filter Criteria”
link in the appropriate section. This adds another set of three builder fields
so you can define additional criteria.
NOTE:
The Filter Builder works as expected with one, two, or any even number of
clauses. However, it needs help with three, five, or any other odd number of
clauses. In these cases, the filter must be balanced. Rather than having an odd
number of clauses, you will need to add a “dummy” query to create an even number.
The dummy query can be an "is not Null" check and exists only to even
out the query to be built by the Filter Builder.
The drop-down field in the middle of the tab
(below the line) presents two options, Or and And. If you have defined components on both halves
of the tab, select the appropriate option for your needs.
· Select
“Or” if you want the filter to locate items that meet the criteria on the top
half of the tab or any of the
criteria on the lower half
· Select
“And” if you want the filter to locate items that meet the criteria on the top
half of the tab plus at least one of
the criteria on the lower half
NOTE:
The Filter Builder cannot be used to build the equivalent of this
expression:
(A
AND B) OR (C AND D)
If you want to create this type of filter,
the filter will need to be defined manually.
The Filter Builder supports the functions
listed below. The date functions are all relative to the current date, and an
only be used if the filter is defined based on a date field.
· [ME]
– The currently logged in user
· [Today] – Today's date
· [CurrentWeekStart] – The first day in the current week
· [CurrentWeekEnd] – The last day in the current week
· [CurrentMonthStart] – The first day in the current month
· [CurrentMonthEnd] – The last day in the current month
· [CurrentYearStart] – The first day in the current year
· [CurrentYearEnd] – The last day in the current year
· [Quarter1Start] – The first day in the first quarter of
the current year
· [Quarter1End] – The last day in the first quarter of the
current year
· [Quarter2Start] – The first day in the second quarter of
the current year
· [Quarter2End] – The last day in the second quarter of
the current year
· [Quarter3Start] – The first day in the third quarter of
the current year
· [Quarter3End] – The last day in the third quarter of the
current year
· [Quarter4Start] – The first day in the fourth quarter of
the current year
· [Quarter4End] – The last day in the fourth quarter of
the current year
· [OneWeekAgoStart] – The first day of the previous week
· [OneWeekAgoEnd] – The last day of the previous week
· [TwoWeeksAgoStart] – The first day of the week before
last
· [TwoWeeksAgoEnd] – The last day of the week before last
· [OneWeekFromNowStart] – The first day of next week
· [OneWeekFromNowEnd] – The last day of next week
· [TwoWeeksFromNowStart] – The first day of the week after
next
· [TwoWeeksFromNowEnd] – The last day of the week after
next
· [OneMonthAgoStart] – The first day of last month
· [OneMonthAgoEnd] – The last day of last month
· [OneMonthFromNowStart] – The first day of next month
· [OneMonthFromNowEnd] – The last day of next month
NOTE:
The filter functions [SiteTitle] and [SiteURL] functions are no longer
supported.
To help you see how filters can be set up, a
few sample screen captures are provided here.
In this example from the Partner Extranet
Dashboard, a filter is defined to locate leads that have been created within
the past 30 days.
This example is taken from the Picture Phone
Book solution. It looks for contact items where the last name starts with A, B,
C, or D.
In this example, a filter is defined to look
for all items that are due in the third quarter of this year AND EITHER:
· High
priority OR
· Not started
To access the fields used to manually build
a filter, click the “Click to manually build a filter” link at the bottom of
the Filter Builder on the Filtering tab. Two main fields are displayed, one
where you can build a complex filter and one where you can build a CAML filter.
Another link at the bottom of this view allows you to return to the Filter
Builder view.
Complex filters allow for SQL-like
information queries. They can be comprised of any number of fields and values.
For example, you can build a filter that looks for records that are not
started, due within seven days, and have a high priority. The fields available to use for filtering are
identified in the Supported Schemas
section of this help, on the “Filterable Fields” line of each identified
schema.
The following values can be used for filters
based on Boolean fields:
· True
· False
· Yes
· No
· 0 (translates to False)
· 1 (translates to True)
For details on defining complex filters,
please see Using
Complex Filters.
NOTE
1: The majority of the date functions available with the Filter Builder
only work with CAML filters. They will not work if you manually build a filter
in the Complex Filter field. The date functions that will work with CAML or
complex filters are:
· [Today]
· [CurrentWeekStart]
· [CurrentWeekEnd]
· [CurrentMonthStart]
· [CurrentMonthEnd]
· [CurrentYearStart]
· [CurrentYearEnd]
NOTE
2: If you define a CAML filter on this page, you cannot return to the Filter
Builder unless you delete the CAML filter. This is by design.
For more information on filters, visit this
site: http://office.microsoft.com/en-us/assistance/HA011611751033.aspx.
If this checkbox is selected and a row or
cell connection has been established with another web part, the filter defined above
will be overridden if a user selects a field in the connected web part. This can
be helpful if you would like to have a defaulted view of information returned
based upon of the fields from the other web part, so as to control the amount
of information returned on the page.
These tips apply whether you choose to use
the Filter Builder or manually define a filter.
Available
Columns for Filter Definition
Columns do not have to be displayed in order
to be referenced in a filter, but they do need to be searchable. Only searchable columns will be listed in the
drop-down field in the Filter Builder. To make a column searchable, the Search
box must selected when the roll-up is created or modified via the Roll-Up
Wizard. By default, all columns that are selected in the Roll-Up Wizard for
display are also marked as searchable.
Contains
vs. Is Equal To or =
Because SharePoint sometimes stores data
differently than the way it is displayed, you may find that you get better
results from your filters when you use the "Contains" operator
instead of "Is Equal To" or “=”.
For example, you may see the name "Bob
Smith" in a list item that includes the Assigned To field. However,
SharePoint stores this name with extra characters, so the actual stored value
may be something like "3;#Bob Smith." Therefore, if you want to
filter on records that were assigned to Bob, you get the desired results if you
build the filter with the "Contains" operator.
Using
Yes/No Columns vs. Choice Columns with Yes/No Options
It is important to understand the difference
between Yes/No columns and Choice columns with Yes and No options.
When you use a Yes/No column, SharePoint
stores a “True” value when the field is selected and leaves it blank when it is
not selected. As a result, if you want to filter on a Yes/No column, you need
to set the filter to look for the appropriate value:
· To
filter on a selected (Yes) value, the filter would be
column is equal to
True (using the Filter Builder) OR
column=True (manually defining the filter)
(replace “column” with the name of your column)
· To
filter on a non-selected (No) value, the filter would be
column is not equal to
True (using the Filter Builder) OR
column<>True (manually defining the filter)
When you use a Choice column with Yes and No
options, the filter should be defined as:
column is equal to
value (using the Filter Builder) OR
column=value (manually defining the filter)
Balancing
Your Filters
The Filter Builder works as expected with
one, two, or any even number of clauses. However, it needs help with three,
five, or any other odd number of clauses. In these cases, the filter must be
balanced. Rather than having an odd number of clauses, you will need to add a
“dummy” query to create an even number. The dummy query can be an "is not Null" check and exists only to
even out the query to be built by the Filter Builder.
When
You DON’T Want to Use the Filter Builder
The Filter Builder cannot be used to build
the equivalent of this expression:
(A
AND B) OR (C AND D)
If you want to create this type of filter,
the filter will need to be defined manually.
As of the Summer 2005 release, all filters
defined via the Filter Builder are automatically converted to Collaborative
Application Markup Language (CAML) when they are saved. The Filter Builder only builds CAML filters.
Unlike some of the other roll-up types, with
calendar roll-ups, filters that are manually defined in the Basic Filter field
are not and cannot be converted to CAML at run-time.
The benefit of CAML is that it applies the
filter to list items before they are
collected and stored by the web part, thereby improving the web part’s
performance. This is particularly
beneficial when roll-ups search through a large number of lists to locate data,
yet the amount of data returned could be small.
It is also useful for more complex filtering.
You do not need to know how to write CAML
code; the conversion will be done automatically. However, if you prefer to manually define a
CAML filter or if the filter you want to create is too complex for the builder
GUI, you can access the Filtering tab on the administration interface and
select the link labeled “Click to manually build a filter.” A CAML field will be provided for your entry.
Do NOT enter any CAML code in the Filter Builder.
NOTE:
This topic applies to customers upgrading from a previous release to Summer
2005. It does not apply to customers upgrading from Summer 2005 to Winter 2006.
If you defined a filter in a previous
version of the Workplace Suite and then upgrade to the Summer 05 release, the
web part will automatically attempt to convert the existing filter to CAML and
display it in the Filter Builder; the existing filter will not be displayed in
the Basic Filter field.
When you see the filter expressions in the
Filter Builder, you may notice that a filter you had defined in a previous
release has been converted differently than you expected. This is due to the way filters were processed
in previous releases, and these conversions ensure that you see the same
results you have always seen. The
operators that are converted differently are:
· =
(equals) – Converted to “contains”
· Not
equal to – Converted to two separate expressions, one with the “not equal to”
operator and one with the “is not null” operator, placed on the lower (“or”)
section of the Filter Builder
You can change the operators, or any other
aspect of the filter, in the Filter Builder if you wish. However, you should be aware that the results
may vary from what you are used to seeing.
There are a few exceptions when filters will
not be converted to CAML. They are:
· When
the basic filter includes an apostrophe (‘)
· When
both a basic filter and a CAML filter have been specified
· When
a basic filter is entered and the “Convert basic filter to advanced filter at run-time” checkbox
has been cleared
· When
a complex filter has been defined
· When
a CAML filter was manually entered that is too complex for the Filter Builder
to display it
In these cases, the Filter Builder will not
be displayed. Instead, the Basic Filter and CAML Filter fields for manual entry
will be displayed. This error message
will be displayed: “The
Filter Builder does not support the current filter settings and cannot be
displayed.”
If a complex filter was defined and you want
to access the Filter Builder, you will need to delete the filter and click Apply. Once this has been done, you
can click the link to access the Filter Builder.
NOTE:
This topic applies only to Summer 2005 and
later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
The Search tab on the administration
interface contains fields that allow you to:
· Define where to begin the search
· Show or hide the Search box
· Require the user to enter search criteria before results
are displayed
· Define a required search, in which you define the
criteria for the data to be displayed and remove the user's ability to perform
a search
· Configure the Search box to present a drop-down list of
criteria to select from, instead of allowing a free-form search
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
This option enables the search bar in the
roll-up display. You can disable the
search bar via a search command (:search:), but you cannot re-enable it in the
same manner. To accommodate this, you can toggle this option on to re-enable
the Search bar.
When this feature is enabled, the web part will
not return any results until the user completes a search. It can save much-needed
performance when accessing multiple lists and/or sites. With some
configuration, this allows you to have multiple roll-ups on a page, each
pointing a different list with a different schema, and utilizing a form web part
or another connected web part as a search mechanism for all roll-ups on that
page.
(Optional) Users are permitted to search for
specific phrases to return only the information that pertains to them. However,
administrators can deactivate this feature by placing a valid search phrase in this
field. When this is done, the web part will return the items found via the
search phrase. The fields that can be utilized in this search string are
identified in the Supported Schemas
section of this help, on the “Search Fields” line of each identified schema.
NOTE:
If anything is entered in this field, the Search function will be deactivated
for general users.
The Search box provided in a roll-up display
can be configured to present a drop-down list of criteria to select from,
instead of allowing a free-form search.
The List URL field is used to define the site from which this list of
criteria is pulled.
The list can be located anywhere in the
system. If the list exists within the same site as this web part, you can leave
the Site URL field blank. As an example, say you have a list of customers
located in your Sales Department sites.
In your Customer Service site, you track the calls from customers. You can configure a roll-up view in Customer
Service to include a search box that provides a drop-down list of customers
that comes from the Sales Department site.
This field should state the Display Name of
the list that you want to use to populate the set of available search criteria.
The Display Name is the name displayed in the "Documents and
Settings" area of SharePoint; it is not the URL name of the list.
NOTE:
The %user% function is not supported in the administration interface. If you
wish to see a list of users from the site you have chosen as a site URL or the
current site, you can use the %user% parameter in the web part properties tool
pane.
Enter the name of the field that you want to
use to populate the search drop-down. The web part will look at all results
within the list and return items from that list field, removing any duplicates.
NOTE:
Keep in mind that this field is referenced to determine the values displayed in
the search drop-down. This is not
the name of the field that will be searched when the search is executed;
searches look at all searchable fields identified in the schema. If you are
working with a custom schema, the searchable fields are the ones you identified
in the “Search” column in the Roll-Up Wizard.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
The fields on this tab are used to select
the type of chart to be displayed and set a wide variety of format settings.
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
This section contains the three fields
described below. These fields determine
the basic format of the chart roll-up.
This drop-down is used to select the chart
format to utilize in the roll-up.
This drop-down is used to select the image
format used when the chart is displayed.
The default is JPEG, but GIF is also supported.
When this checkbox is selected, the value of
the items returned will be displayed at the end of each bar as a percentage of
the total results. When it is not
selected, the value of the items returned will be displayed as defined in the
Data Type field in Chart Data Settings (see below).
This area of the Display tab is used to
define the groups of values presented by the chart. You can also define the
data colors and titles used within the chart, as well as the type of value
presented (count, sum, average, or direct result).
This field is used to define the label to be
displayed for each bar in the chart.
This field is used to define whether the
data returned by the chart should be counted, summed up, averaged, or simply return
the value of a specific field.
If you choose Average, Sum, or a Return
Value, the field type must be an integer or no data will be returned. If you choose Count, the total number of
items will be returned.
Any fields that include a space or special
character need to be placed within [ and ] brackets in order to be recognized.
Examples:
· Count(Title)
· Avg([% Complete])
· Sum([Parts Sold])
· [% Complete]
Calculated fields are not supported.
The filter to use to determine which items
should be returned from the lists. This field
follows the same rules as manually defining a complex filter on the Filtering
tab. For details on how to define a
complex filter, see Using
Complex Filters.
The color in which the data will be
displayed. Standard charts begin with red and end with yellow, but this can be
altered using the Choose Color link. If nothing is entered here, red will be
utilized as the default color.
Each set of the fields defined above
represents a single group of data that is presented by the bar chart or pie
chart. Another way to look at this is as
a single bar or slice on the chart. When you first add a chart roll-up onto a
page and utilize the default settings, you will see that there are multiple groups
defined in the Chart Data Settings section.
You can add to or modify these groups if you wish.
· To
add a new group (bar or slice), click any of the Add Data Grouping links provided on
the page. A new set of entry fields is
provided at the bottom of the Chart Data Settings section. All you need to do is fill out the fields as
described above. Make sure you click Apply or OK at the bottom of the Display tab
when you are finished.
· To
remove a group (bar or slice) from the chart, locate the group you want to
remove and click the Remove
Data Grouping link immediately below it. Make sure you click Apply or OK at the bottom of the Display tab
when you are finished.
This area of the Display tab is used to
define the properties of the chart itself.
This field is used to define the title to be
displayed at the top of the chart.
This field is used to define the name of the
font to be used for the title.
This field is used to define the size of the
font in which the title will be displayed. If the Font Color is defined, the
Font Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the color that
will be displayed behind the chart title. To select a color, use the Choose
Color link.
This field is used to define the name of the
font to be used for labels along the X axis of the bar chart.
This field is used to define the size of the
font in which the X axis labels will be displayed. If the X Font Color is defined, the X Font
Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the title that
will be displayed below the chart’s X axis.
This field is used to define the name of the
font to be used for the title below the chart’s X axis.
This field is used to define the size of the
font in which the X axis title will be displayed. If the X Data Value Header Font Color is
defined, the X Data Value Header Font Size is also required.
This field is used to define the color of
the font in which the X axis title will be displayed. To select a color, use
the Choose Color link.
This field is used to specify the text
format for the labels along the x axis of the bar chart. For example, if the chart displays a
percentage from 1-100, you might want to display the title at each line as
20%-40%-60%-80%-100%. If so, the separation of each line in the bar chart could
be defined as {value} %.
Example: ({value}%, ${value})
To learn more about value substitution, see Parameter Substitution Properties.
This field is used to define the name of the
font to be used for labels along the Y axis of the bar chart.
This field is used to define the size of the
font in which the Y axis labels will be displayed. If the Y Font Color is defined, the Y Font
Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the title that
will be displayed below the chart’s Y axis.
This field is used to define the name of the
font to be used for the title below the chart’s Y axis.
This field is used to define the size of the
font in which the Y axis title will be displayed. If the Y Data Value Header Font Color is
defined, the Y Data Value Header Font Size is also required.
This field is used to define the color of
the font in which the Y axis title will be displayed. To select a color, use
the Choose Color link.
This field is used to specify the text
format for the labels along the Y axis of the bar chart. For example, if the chart displays a
percentage from 1-100, you might want to display the title at each line as
20%-40%-60%-80%-100%. If so, the separation of each line in the bar chart could
be defined as {value} %.
Example: ({value}%, ${value})
To learn more about value substitution, see Parameter Substitution Properties.
This field is used to define the image width
of the bar chart display, stated in pixels, This does not control the width of
the bar chart itself; it controls the total width of the image displayed to the
user.
This field is used to define the image height
of the bar chart display, stated in pixels.
Like the Image Width setting, this does not control the height of the bar
chart itself; it controls the total height of the image displayed to the user.
This field is used to define the X
coordinate location of where the bar chart begins within the image. Note that if
you choose to have a X Value Data Header, you will need to leave room for this
to be displayed in the image as well.
This field is used to define the Y
coordinate location of where the bar chart begins within the image. Note that
if you choose to have a Y Value Data Header, you will need to leave room for
this to be displayed in the image as well.
This field is used to define the width of
the bar chart within the image, stated in pixels. If you take the total Image Width
and subtract the X Location, you should be able to come up with a number which
allows the bar chart to take up the remainder of the image width.
This field is used to define the height of
the bar chart within the image, stated in pixels. If you take the total Image Height
and subtract the Y Location, you should be able to come up with a number which
allows the bar chart to take up the remainder of the image height.
When creating a bar chart, the highest value
used is usually where the bar chart’s X value or Y value will end. This may not suit your needs if you want to
display a static number, a total count of items, a sum of items, or the highest
item. With this in mind, you can utilize four different variables in this field
to create the results you want:
· The
total count of items returned for each filter
Example: count
· The sum/average/count/minimum/maximum
of items returned for each filter
Format: Sum(Field), Avg(Field), Count(Field), Min(Field), Max(Field)
Example: Sum(Server Count)
· The
highest number returned in the values displayed
Example: highest
· A
static number
Example: 100,000
This field is used to change the display of
information for the Aggregate Value displayed at the end of the bar in the bar chart.
For instance, to display a percentage value, you would use
{value} %.
Example ({value}%, ${value})
If this checkbox is selected, the bar chart will
display an aggregate value at the end of the value bar. If it is left blank, no
aggregate value will be displayed.
If this checkbox is selected, the bar chart colors
will be faded by 20% to provide a transparent effect. If it is left blank, all
colors will be opaque. This option is applicable only when a GIF format is
used; it does not apply to JPEG.
If this checkbox is selected, the default
colors for separation will be utilized in the bar chart. If it is left blank, the default color of red
will be used.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
The fields on this tab are used to select the
type of chart to be displayed and set a wide variety of format settings.
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
This section contains the three fields
described below. These fields determine
the basic format of the chart roll-up.
This drop-down is used to select the chart
format to utilize in the roll-up.
This drop-down is used to select the image
format used when the chart is displayed.
The default is JPEG, but GIF is also supported.
This checkbox does not apply to Gantt
charts, so it should be left blank.
This area of the Display tab is used to
define the format and labels used in the chart.
This field is used to define the name of the
field that represents the title of each task.
This field is used to define the name of the
field that represents the Start Date. This must be a date type field.
This field is used to define the name of the
field that represents the End Date. This must be a date type field.
This field is used to define the color utilized
to display each bar in the chart. To
select a color, use the Choose Color link.
This area of the Display tab is used to
define the properties of the chart itself.
This field is used to define the title to be
displayed at the top of the chart.
This field is used to define the name of the
font to be used for the title.
This field is used to define the size of the
font in which the title will be displayed.
If the Font Color is defined, the Font Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the color that
will be displayed behind the chart title.
To select a color, use the Choose Color link.
This field is used to define the name of the
font to be used for labels along the X axis of the Gantt chart.
This field is used to define the size of the
font in which the X axis labels will be displayed. If the X Font Color is defined, the X Font
Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the name of the
font to be used for labels along the Y axis of the Gantt chart.
T This field is used to define the he size of
the font in which the Y axis labels will be displayed. If the Y Font Color is defined, the Y Font
Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the image width
of the Gantt chart display, stated in pixels, This does not control the width
of the Gantt chart itself; it controls the total width of the image displayed
to the user.
This field is used to define the image height
of the Gantt chart display, stated in pixels.
Like the Image Width setting, this does not control the height of the Gantt
chart itself; it controls the total height of the image displayed to the user.
This field is used to define the X
coordinate location of where the Gantt chart begins within the image.
This field is used to define the Y
coordinate location of where the Gantt chart begins within the image.
This field is used to define the width of
the Gantt chart within the image, stated in pixels. If you take the total Image
Width and subtract the X Location, you should be able to come up with a number
which allows the Gantt chart to take up the remainder of the image width.
This field is used to define the height of
the Gantt chart within the image, stated in pixels. If you take the total Image
Height and subtract the Y Location, you should be able to come up with a number
which allows the Gantt chart to take up the remainder of the image height.
By default, each line in the Gantt chart
will be separated by seven days. To increase or decrease this value, enter the
number of days to use as a separator in this field.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
The fields on this tab are used to select
the type of chart to be displayed and set a wide variety of format settings.
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
This section contains the three fields
described below. These fields determine
the basic format of the chart roll-up.
This drop-down is used to select the chart
format to utilize in the roll-up.
This drop-down is used to select the image
format used when the chart is displayed.
The default is JPEG, but GIF is also supported.
This checkbox does not apply to pie charts,
so it should be left blank.
This area of the Display tab is used to
define the groups of values presented by the chart. You can also define the
data colors and titles used within the chart, as well as the type of value
presented (count, sum, average, or direct result).
This field is used to define the label to be
displayed for each slice in the chart.
This field is used to define whether the
data returned by the chart should be counted, summed up, averaged, or simply return
the value of a specific field.
If you choose Average, Sum, or a Return
Value, the field type must be an integer or no data will be returned. If you choose Count, the total number of
items will be returned.
Any fields that include a space or special
character need to be placed within [ and ] brackets in order to be recognized.
Examples:
· Count(Title)
· Avg([% Complete])
· Sum([Parts Sold])
· [% Complete]
Calculated fields are not supported.
This field is used to define the filter to
use to determine which items should be returned from the lists. This field follows the same rules as manually
defining a filter on the Filtering tab.
For details on how to define a complex filter, see Using Complex Filters.
This field is used to define the color in
which the data will be displayed. Standard charts begin with red and end with yellow,
but this can be altered using the Choose Color link. If nothing is entered here,
red will be utilized as the default color.
This
field applies only to 3D multi-level pie charts. It indicates the depth in pixels in which the
data will be represented.
Examples:
· 10
· 20
· 35
Each set of the fields defined above
represents a single group of data that is presented by the bar chart or pie
chart. Another way to look at this is as
a single bar or slice on the chart. When you first add a chart roll-up onto a
page and utilize the default settings, you will see that there are multiple
groups defined in the Chart Data Settings section. You can add to or modify these groups if you
wish.
· To
add a new group (bar or slice), click any of the Add Data Grouping links provided on
the page. A new set of entry fields is
provided at the bottom of the Chart Data Settings section. All you need to do is fill out the fields as
described above. Make sure you click Apply or OK at the bottom of the Display tab
when you are finished.
· To
remove a group (bar or slice) from the chart, locate the group you want to
remove and click the Remove
Data Grouping link immediately below it. Make sure you click Apply or OK at the bottom of the Display tab
when you are finished.
This area of the Display tab is used to
define the properties of the chart itself.
This field is used to define the title to be
displayed at the top of the chart.
This field is used to define the name of the
font to be used for the title.
This field is used to define the size of the
font in which the title will be displayed.
If the Font Color is defined, the Font Size is also required.
This field is used to define the color of
the font in which the title will be displayed. To select a color, use the
Choose Color link.
This field is used to define the color that
will be displayed behind the chart title.
To select a color, use the Choose Color link.
This field is used to define the name of the
font to be used for the data labels around/next to the pie chart.
This field is used to define the size of the
font in which the data labels will be displayed. If the Data Value Font Color is defined, the
Data Value Font Size is also required.
This field is used to define the color of
the font in which the data labels will be displayed. To select a color, use the
Choose Color link.
This field is used to define the image width
of the pie chart display, stated in pixels. This does not control the width of
the pie chart itself; it controls the total width of the image displayed to the
user.
This field is used to define the image height
of the pie chart display, stated in pixels.
Like the Image Width setting, this does not control the height of the pie
chart itself; it controls the total height of the image displayed to the user.
This field is used to define the X coordinate
location of the center of the pie chart. This is usually set to half of the
total Image Width.
This field is used to define the Y
coordinate location of the center of the pie chart. This is usually set to half
of the total Image Height.
(Winter 2006 and later releases only.)
This property is used to define the radius of the pie chart, stated in pixels.
The radius represents one side of the pie, so this setting changes the complete
width of the pie. If you leave this property blank, it defaults to a value of
100.
When this checkbox is selected, the data
values will be presented to the side of the image and will not be permitted to
overlap. If this checkbox is left blank, the data values will be placed
directly next to the corresponding section of the pie chart.
If this checkbox is selected, the pie chart colors will be faded by 20% to provide a
transparent effect. This is particularly useful for 3D multi-level pie charts,
as it allows you to more clearly see the different levels of the pie. If
this checkbox is left blank, all colors will be opaque. This option is
applicable only when a GIF format is used; it does not apply to JPEG.
If this checkbox is selected, the default
colors for separation will be utilized in the pie chart. If it is left blank, the default color of red
will be used.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
The Localization tab allows you to customize
the messages, prompts, button labels, and options displayed by the web part
(e.g., link to add a new item, message displayed when no records meet the
criteria for the roll-up, etc.). It also allows you to customize all of the
text on the administration interface, including tab and section names and
descriptions, field names, drop-down field options, and button labels. Content is grouped by the tab on which it
appears.
An additional section on this tab, which is
labeled with the web part name, allows you to modify the following:
· Administration interface tab names
· Messages displayed to users (e.g., no items found, web
part time out, prompt to execute a search)
· Search button label
· Text used for “Actions” and “Show Version” options on
web part menu
· Text used for options presented when “Actions” is
selected from web part menu
To customize any of this information, simply
locate the text you want to change and type over it with the desired content.
Use the filter at the top of the tab to
easily find content. Just type the content you're looking for and then click
Filter.
To reset a value back to its default, delete
the value in the text box and apply the changes by clicking OK or another
administration tab. The next time the corresponding tab loads, the default
value will be displayed.
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
You may find it helpful to open another
browser session and view the results of your customizations as you save your
changes.
NOTE
1: A new DisplayXML property replaces the LCIDXML property. For users that
have entered LCIDXML in previous roll-ups, the LCIDXML will be upgraded to the
new DisplayXML property automatically. The Summer 2005 and later releases do not
support manual edits of the DisplayXML. The Localization tab should be used
instead.
NOTE
2: The DisplayXML for Summer 2005 and later releases does not support more
than one language. If your previous
LCIDXML property was set up for multiple languages, the ‘default’ LCID will be
used.
NOTE:
This topic applies only to Summer 2005
and later Advanced Chart Roll-Ups. If you are working with a prior release,
please see “Web Part Properties
(Pre-Summer 2005 Only)” instead.
When you are finished making your selections
on this tab, click any other administration tab to save your changes and keep
the administration interface open, or click OK to save your changes and return
to the roll-up display.
When this checkbox is selected, the web part
(Web Part A in the example below) is allowed to manage its own threads, rather
than submitting threads to be serially queued in the SharePoint thread
management process. This allows parallel execution of multiple web parts,
improving server performance under heavy loads.
NOTE:
This option should only be enabled if you meet the following criteria.
· Your
web server has multiple processors
· Web
Part A is being used for heavy transactions against SQL server, returning
1000+ Items
· There
is a heavy user load on web part A
· You
have configured the IIS application pool corresponding to the virtual server to
use multiple worker processes (a.k.a. Web Garden)
Enabling this option on Web Part A may not
improve the performance of Web Part A. However, this option is designed to
allow Web Part A to run independently of the SharePoint web part queue. This
means that control will be returned to the SharePoint process more rapidly,
allowing other web parts and web part pages to be rendered while the
“expensive” Web Part A is running.
IMPORTANT!
Only perform the following steps if you understand the use and impact of
editing the web.config file.
If you enable this option and notice that
the web part times out, you will be required to update the web.config
for the virtual server hosting the site where this web part is being used.
NOTE:
Make a copy of the web.config file before attempting the following.
The web.config file has a line which states
"<WebPartWorkItem Timeout="7000" />". This specifies
the amount of time given to a thread to collect and present data. If you are
collecting large amounts of data, this may need to be increased to support this
higher load. The 7000 represents 7000 milliseconds. If you wish to allow a
thread to execute for a longer period, you must change this to the value you
require. (Example: 60 Seconds = 60000). Some experimentation may be required.
When this checkbox is selected, the web part
will cache the data after a filter operation has been completed. This setting is
overridden if a web part connection has been enabled.
When this checkbox is selected, the roll-up
results will be cached per user instead of for all users. The difference is
that if your users have the same access to the same data collected by the web
part, it may be more prudent to turn this off so the data is stored in memory
only once. The opposite holds true if your users have access to different
pieces of data; in this case, it would be more effective to enable Cache Per
User.
When this checkbox is selected, caching of the
data collected by the web part is enabled. When enabled, all information
collected by the web part will be stored in the server’s memory for future use.
This can save on performance, as data is not collected each time a hit is
completed on the web part. Since the web part executes a double-hit against the
page to create the calendar image, it is recommended you activate this
property.
By default, the URL of each chart image
includes information that references the web part ID. The ID changes each time the web part is
reinstalled on a page. If you create a
link to a chart whose URL includes a reference to this web part ID and then the
chart is changed or accidentally deleted, the link will not work.
If you place a mark in this checkbox, the
Image ID will not include a reference to the web part ID, and the page will
maintain the identity of the image. This
allows you to use the image on another web site or SharePoint site without
having to worry about the web part being deleted and recreated.
This field is used to define an integer to
reflect the number of minutes for which information will be cached. The default
is 1 minute, but this can be increased or decreased as necessary. The only
entry permitted here is a number.
This field is utilized when a cell consumer
connection has been established between another web part and this one. It
identifies the cell that you want to filter on for the results that are
collected by this web part. For instance, if you have collected the Date Due
field and you want to compare it to the End column from another web part, you
would type Date Due in this field. Once that is done, all filters would be performed
via the "Date Due" column.
This field allows you to change the default SPS
My Site characteristics of the web part. By default, the web part will modify
the URL "/mysite" to point to "/personal/User". This allows
the web part to search through the MySite section of SharePoint Portal Server. However,
SPS allows the administrator to alter the URL definition for each SPS server. To
accommodate this, the SPS My Site Path field allows you to alter the web part
to support your organization’s SPS My Site setup.
This field is used to define the URL to link
to when a user clicks on a piece of data in the chart.
This field is used to define the text that is displayed when a
user places their mouse over the chart and a link is displayed. Make sure the proper
variables are used within the title tag. For example, title='${value}' returns
the data value with a $ symbol in front. To learn more about value substitution,
see Parameter Substitution
Properties.
NOTE: This topic
applies only to versions of the Chart Display Advanced web part from before the Summer 2005 release. If you
are working with Summer 2005 or a later release, please see “Admin: Sites and Lists Tab” instead.
The Administration View of a roll-up web part is displayed
when you first drag and drop the web part onto a page. It can also be accessed via
the Actions menu. This view is used to select the sites, portals, and/or
sub-areas and lists to include in the user presentation of the roll-up. You can
select any number of lists or libraries from any number of sites on the server
that the web part is running on as the source for the roll-up.
This field is used to specify how the web part should
identify the sites and lists to include in the roll-up display.
· Selective allows you to select each
specific list that you want to include. If you choose Selective, the
"Available Lists" and "Current Lists" fields will be
activated.
· Line of Site enables you to identify a
URL and the number of levels below that URL to include in the display. Any sites
that exist now or are created in the future within the specified number of
levels will be automatically recognized and included in the roll-up display. If
you choose Line of Site, the "Available Lists" and "Current
Lists" fields are not used. Make sure you click the "Save
Selection" button to save the settings entered in the "Site URL"
and "Levels Searched" fields.
Did you know… With
Selective roll-ups, you can reference a list to which your users have read
access in a site to which they do not have access. This is because
Selective roll-ups hard-code the URL of the site and list, and do not check to
see if the user has access to the entire site, as Line of Site roll-ups do.
(Optional) This field is used to define the URL for the site
(or the top-level site) you want to access and from which you want to return a
list. This can be any SharePoint site that resides on the same server as this
web part. If this field is left blank, it will default to the URL where the web
part is placed.
The format for the URL is http://Site-URL/SiteName.
Examples:
· http://www.sitename.com/
· http://www.sitename.com/site1
· http://www.sitename.com/site1/site1a
To include lists from more than one site, you can place a
semicolon (;) between the URLs you want to access. Make sure there is no space
between the first URL, the semicolon, and the second URL.
Example:
http://www.sitename.com;http://www.othersitename.com/site
This applies to both Selective and Line of Site return types.
TIP: If the site
that contains the lists you want to work with is displayed in the Workplace
View Advanced web part, you can right-click on the site, select Copy Shortcut,
and paste the URL in the Site URL field.
(Optional) This field is used to define the number of levels
to search within a site to find lists for the roll-up display. If this field is
left blank, it will default to 0, which searches only the site named in the
“Site URL” field. The maximum recommended number of levels is 10.
Please make sure that a number is entered in this field. If
you spell out a number, it will result in an error and no lists will be found.
This drop-down field lists all of the available schemas that
can be used with this web part. The default is “Utilize All Schemas.” However,
you can choose to include only those lists that utilize a particular schema.
This can be useful to narrow your search to those list templates that include
the fields that you want to use.
Schemas contain the elements that identify a list: the list
type, filter and search fields, display fields, and so on. When you select a
schema, the elements of that schema will be used to find only those lists that
match that schema profile. Lists of schemas can be found in the Supported Schemas section of this web part help.
If you have created your own schemas, you will not be able
to select them from the Schemas drop-down for the out-of-the-box CorasWorks
Chart roll-ups. You will need to create your own version of the roll-up web
part that references your custom schema using the Roll-Up Wizard, which is
available with the Developer and Small Business editions of the Workplace
Suite.
This button will execute a search of the chosen site
structure and then display the sites and lists that match your criteria in the
"Available Lists" drop-down field.
This button will save your web part settings for the Line of
Site return type. You must click this button if a change has been made to the
selections in the “Site URL”, “Levels Chosen”, or “Schema” fields.
This area displays the lists available to be chosen for
return by the web part. This includes all available lists, even if they have
already been selected and are displayed in the "Current List(s)"
field. The format for the lists displayed in this field is “Site Name | List
Name.”
Select a list to add it to the web part display. Select
"Add All Sites & Lists" to include all of the lists returned in
the web part display.
This area displays
all of the lists you have selected to include in the roll-up display.
The format for the lists displayed in this field is “Site Name | List Name.”
To remove a list, simply highlight the list and it will be
removed from the display. Select "Remove All Sites & Lists" to
remove all of the lists from the roll-up display.
This shows the currently supported charts available to be
displayed by the web part. Currently, 2D Pie Chart, 3D Pie Chart, 3D
Multi-Level Pie Chart, 2D Horizontal Bar Chart, 3D Horizontal Bar Chart, 2D
Vertical Bar Chart, 3D Vertical Bar Chart, and Gantt are supported. To see a
picture of each, see the Chart
Examples page.
After the chart is chosen, the proper settings will be automatically
configured within the web part in order for the chart to be viewed. If the
Chart Properties have been altered, these will remain and could affect the
output of the chart. Keep this in mind before changing the display of a chart
from one type to another.
This button closes the Administration view and returns you
to the web part’s data view.
NOTE: This
topic applies only to versions of the Chart Display Advanced web part from before the Summer 2005 release. If you
are working with Summer 2005 or a later release, please see the corresponding
“Admin Tab” topic instead.
This toggle is used to activate or deactivate caching of the
data collected by the web part. If this toggle is on, all information collected
by the web part will be stored in the server’s memory for future use. This can
help improve performance, as data will not be collected each time a hit is
completed on the web part. Since the web part executes a double-hit against the
page to create the graph image, CorasWorks recommends that this property be
turned on.
This text box is used to set the number of minutes
information will be cached. The default is 1 minute, but this can be increased
or decreased as necessary. The only entry permitted here is a number.
This toggle is used to indicate whether the results returned
should be cached separately for each user or for all users. If your users have
the same access to the same data collected by the web part, it may be more
prudent to turn this off so the data is stored in memory only once. The
opposite holds true if your users have access to different pieces of data; if
that is the case, Cache Per User should be enabled.
This toggle allows the web part to cache the data after a
filter operation has been completed. If a web part connection has been enabled,
the data will be cached before the filter is applied.
This text box is utilized when a cell consumer connection
has been established between this web part and another web part. It is used to
identify the cell to filter on for the results collected by this web part. For
instance, if you collect the Date Due field and want to compare it to the End
column from another web part, you would type Date Due in the Cell Field Name
field to apply all filters via the Date Due field.
This text box will allow you define the groups of filters to
apply to the values in the chart. It is also used to define the color of the
pie sections/bars used, the value title, and type of value (Count, Sum,
Average, or Direct Result). Pie and Bar charts permit you to define multiple
groups, while Gantt charts only permit one. The specific parameters vary
depending on the type of chart. For more
details, please see Pie Charts:
Chart Properties, Bar Charts:
Chart Properties, Gantt
Charts: Chart Properties or Chart
Examples.
This text box will allow you to define the properties of the
chart (e.g., chart title, fonts, image size). The specific parameters vary
depending on the type of chart. For
details, please see Pie Charts:
Chart Properties, Bar Charts:
Chart Properties, Gantt
Charts: Chart Properties, or Chart
Examples.
This text box will allow you to enter the URL to link the
chart to when a user clicks on the chart.
It also allows you to define the ALT tag (pop-up) used in the link. To
see how this can be utilized, please see Pie Charts: Chart Properties, Bar Charts: Chart Properties, Gantt Charts: Chart Properties,
or Chart Examples.
This text box allows you to enter the Image Format that will
used to display the Chart. The current supported types are
"image/jpeg;1" and "image/gif;0". If any other text is
located here, "image/jpeg;1" will be used as the default.
By default, the URL of each chart image includes information
that references the web part ID. The ID
changes each time the web part is reinstalled on a page. If you create a link to a chart whose URL
includes a reference to this web part ID and then the chart is changed or
accidentally deleted, the link will not work.
This toggle will allow you to alter the save of the Image ID so that it
does not include a reference to the web part ID, and the page maintains the
identity of the image. This allows you
to use the image on another web site or SharePoint site without having to worry
about the web part being deleted and recreated.
This selectable choice shows the web part’s Administration
view, allowing Administrators to manage the lists and schemas utilized by the
web part. This view is only available to Administrators of the Site or Web, or
it can be viewed within in a Shared View.
(Optional) Users are permitted to search for specific
phrases to return only the information that pertains to them. However,
Administrators can deactivate this feature by placing a valid search phrase in
the Required Search String field. When this is done, the web part will return
the items found via the search phrase. The fields that can be utilized in this
search string are identified in the Supported Schemas
section of this help, on the “Search Fields” line of each identified schema.
NOTE: If anything
is entered in this field, the Search function will be deactivated for general
users.
(Optional) Administrators can use the Filter field to
control the web part’s return at a higher level. Unlike the Required Search
String (above), Administrators can specify the field to search and, if anything
is entered here, users will still be able to search on the filtered return.
The fields available to use for filtering are identified in
the Supported Schemas section of this help, on the
“Filterable Fields” line of each identified schema.
A noticeable difference between this filter and other
CorasWorks filters is that this is designed to use only a complex filter. The
“field=text” format is not permitted; only the new complex filter format can be
used. For details regarding how to create a complex filter, see Using Complex Filters.
Because standard complex filters cannot handle the Date Add
function, CorasWorks has built in an add function that can be used within the
filter. The format for the add function is ":add:date(optional):#:add:"
If you do not wish to place a date within the :add: function, the format would
alter and look like this ":add:#:add:". The # signifies a number and
can be a positive or negative integer.
Keep in mind the fact that filters look for values in a
specific field. If you want to look for a specific value in any field, use a search, instead.
Examples:
Requirement 1:
Show me all tasks which are
assigned to me and are due within seven days
Use:
[Assigned To]='[ME]' AND [Due Date]>#:add:-1:add:# AND [Due
Date]<#:add:today:7:add:#
Requirement 2:
Show me all tasks which are
assigned to me or to another identified user
Use:
[Assigned To]='[ME]' || [Assigned
To]='UserName'
Requirement 3:
Show me all tasks which are not
assigned to me
Use:
Not [Assigned To]='[ME]'
Where...
[ME] = Currently
Logged In User
[TODAY] = Today's Date
:add:7:add: = Add To Today's Date 7 Days
:add:1/1/2006:7:add: = Add 7 Days to 1/1/2002 (1/8/2006)
The following filter helpers are made available for use by
4.0 Complex Filters. These are not recommended for use here, but are available
if you wish.
[Today] = Today's Date
[CurrentYearStart] = Current Year’s First Day Date
[CurrentYearEnd] = Current Year’s Last Day Date
[CurrentWeekStart] = Current Week’s First Day Date
[CurrentWeekEnd] = Current Week’s Last Day Date
[CurrentMonthStart] = Current Month’s First Day Date
[CurrentMonthEnd] = Current Month’s Last Day Date
1. Available Columns
for Filter Definition
Columns do not have to be displayed in order to be
referenced in a filter, but they do need to be searchable. To make a column searchable, the Search box
must selected when the roll-up is created via the Roll-Up Wizard. Be default,
all columns that are selected in the Roll-Up Wizard for display are also marked
as searchable.
2. Contains vs. Is
Equal To or =
Because SharePoint sometimes stores data differently than
the way it is displayed, you may find that you get better results from your
filters when you use the "Contains" operator instead of "Is
Equal To" or “=”.
For example, you may see the name "Bob Smith" in a
list item that includes the Assigned To field. However, SharePoint stores this
name with extra characters, so the actual stored value may be something like
"3;#Bob Smith." Therefore, if you want to filter on records that were
assigned to Bob, you get the desired results if you build the filter with the
"Contains" operator.
3. Using Yes/No
Columns vs. Choice Columns with Yes/No Options
It is important to understand the difference between Yes/No
columns and Choice columns with Yes and No options.
When you use a Yes/No column, SharePoint stores a “True”
value when the field is selected and leaves it blank when it is not selected.
As a result, if you want to filter on a Yes/No column, you need to set the
filter to look for the appropriate value:
· To
filter on a selected (Yes) value, the filter would be “column=True” (replace “column” with the name of your column)
· To
filter on a non-selected (No) value, the filter would be “column<>True”
When you use a Choice column with Yes and No options, the
filter should be defined as “column=value”.
If a row or cell connection has been established with
another web part, you can configure this web part to override the above filter
if someone chooses a field in the connected web part (so the connection takes
precedence over the filter). This is useful if you want to return a default
view of information based upon the selection from the other web part and
control the amount of information returned on the page.
NOTE: This topic
applies only to versions of the Chart Display Advanced web part from before the Summer 2005 release. If you
are working with Summer 2005 or a later release, please see “Admin:Display Tab”
instead.
CorasWorks utilizes a product called Chart Director to
maintain charts. Because of this, some portions of this help will mention the
Chart Director product. Chart Director creates each chart and the CorasWorks web
part then displays the chart to the user.
By default, these settings will be set up for a standard
Task list the first time you choose a chart.
The Chart Data text box is used to define the data and
formats used within the chart.
There are five parameters that can be set to be rendered into
a bar chart. Each grouping of parameters is preceded with a <Group> tag, indicating
a new data stream. [? Flash]
To display all of the calculations as a percentage of the total
results, place a <Percentage> tag prior to the first group.
[? Flash]
Example: Two Items Returned [? Flash]
Format: <Group>Parameter
1;Parameter2;Parameter3;Parameter4;Parameter5<Group>Parameter
1;Parameter2;Parameter3;Parameter4;Parameter5
Data: <Group>Not Started;Count(Title);Status='Not Started';0xCC0000;50<Group>In
Progress;Count(Title);Status='In Progress';0x000099;40
Example: Two Items Returned - Percentage [? Flash]
Format: <Percentage><Group>Parameter 1;Parameter2;Parameter3;Parameter4;Parameter5<Group>Parameter
1;Parameter2;Parameter3;Parameter4;Parameter5
Data: <Percentage><Group>Not Started;Count(Title);Status='Not
Started';0xCC0000;50<Group>In Progress;Count(Title);Status='In
Progress';0x000099;40
This parameter defines title to display for each data
element returned.
Examples: Not Started, In Progress, Completed
This parameter defines the data type that will be returned.
You can have the data counted, summed up, or averaged, or just return the value
of a specific field. If you choose Average, Sum, or Return Value, the field
type must be Integer, otherwise no data will be returned. If you choose Count,
the total number of items returned will be returned, which doesn't require the
field to be of an integer type.
Notice in the example below that field names that include a
space or special character need to be placed within a "[" and
"]" in order to be recognized.
Examples: Count(Title), or Avg([% Complete]), or Sum([Parts Sold]), or [%
Complete]
Calculated fields are not supported.
This is the filter that is used to return the proper items
from the lists. This filter uses the same complex filter type as is used in the
"Filter" property for this web part. To learn more about filters, go
to Web Part Properties/Return Properties.
Examples: Status='Not Started', or [Assigned To] IS NOT
NULL, or [Due Date]>#[TODAY]#
This parameter defines the color the data field will be
displayed in. Standard charts begin with red and end with yellow, but these colors
can be altered. If nothing is entered here, red will be utilized as the default
color. Any value entered here must be in HEX format, or an error will occur. To
see a list of available colors, refer to the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The Chart Properties text box is used to define several properties
for the chart such as font color, header color, and so on. All parameters are
optional, but certain parameter settings may become required if the next
setting is entered.
12 chart property parameters are available for bar charts. Each parameter is separated by a semicolon
(;).
All settings within a parameter must be separated by a comma
(,). The comma signifies the next setting. If you choose not to define an
optional setting, it is not necessary to place any data between the first comma
and the next comma.
Format: P1-Setting1,P1-Setting2,P1-Setting3,P1-setting4,P1-Setting5;P2-Setting1,P2-Setting2,P2-Setting3;P3-Setting1,P3-Setting2,P3-Setting3,P3-Setting4,P3-Setting5;P4-Setting1,P4-Setting2,P4-Setting3;P5-Setting1,P5-Setting2,P5-Setting3,P5-Setting4,P5-Setting5;P6-Setting1,P6-Setting2;P7-Setting1,P7-Setting2,P7-Setting3,P7-Setting4;P8;P9;P10;P11;P12
Example:
2D Horizontal Bar Chart,arialbd.ttf,10,0x000000,0xcc0000;arial.ttf,10,0xCC0000;Status,arialbd.ttf,10,0xCC0000,%{label};arial.ttf,10,0x990000;Percentage,arialbd.ttf,10,0x990000,%{label};500,250;40,80,400,250;true;true;highest;${value};false
The settings within this parameter define the content and
format of the chart title.
Example: 2D Horizontal Bar Chart,arialbd.ttf,10,0x000000,0xcc0000
Result: 2D Horizontal Bar Chart
This the title that will be displayed at the top of the chart.
Examples: 2D Horizontal Bar Chart, Status of Current Projects, or Customer
Satisfaction Levels
This defines the font used to display the chart title. To see how you can change the font type, go
to Font Properties.
This defines the size of the font used to display the chart
title. This field is required if the Font Color (Setting 4) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the Chart Title will be
displayed in. If you enter a value here, it must be in HEX format, or an error
will occur. To see a list of available colors, see to the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This defines the background color to be used behind the
Chart Title. If you enter a value here,
it must in HEX format, or an error will occur. To see a list of available
colors, see to the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The settings within this parameter are used to define the
font style, color, and type used for data on the X axis of the bar chart.
Example: arial.ttf,10,0xCC0000
Result: Not
Started
This setting is used to define the font used to display data
values on the X axis of the bar chart. To
see how you can change the font type, go to Font Properties.
This setting is used to define the font size used to display
data values on the X axis of the bar chart.
This field is required if the Font Color (Setting 3) is defined.
Examples: 15, or 16, or 20, or 10
This defines the color that the data values on the X axis of
the bar chart will be displayed in. If you enter a value here, it must in HEX
format, or an error will occur. To see a list of available colors, see the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The settings in this parameter define the content and format
of label used on the X axis of the bar chart..
Example: Status,arialbd.ttf,10,0x990000,%{label}
Result: Status
This defines the title that will be displayed next to the
values on the X axis.
Examples: Percentage, Status, or Number of Units Sold
This defines the font used to display the X axis label. To
see how you can change the font type, go to Font Properties.
This defines the size of the font used to display the X axis
label. This field will be required if the X Data Value Header Font Color (Setting
4) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the x axis label will be
displayed in. If you enter a value here, it must be in HEX format, or an error
will occur. To see a list of available colors, see to the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This setting allows you to define the format of the data
labels provided on the X axis of the bar chart. For instance, say you want to display
a percentage range from 1-100 (so the labels would be 20%-40%-60%-80%-100%). In
this example, you would use {value} %.
Example: {value}%, ${value}
To learn more about value substitution, see Substitution Properties.
The settings within this parameter are used to define the
font style, color, and type used for data on the Y axis of the bar chart.
Example: arial.ttf,10,0x990000
Result: 20%
This is used to define the font used to display data values
on the Y axis of the bar chart. To see how you can change the font type, go to Font Properties.
This setting is used to define the font size used to display
data values on the Y axis of the bar chart. This field is required if the Y
Font Color (Setting 3) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the data values on the Y
axis of the bar chart will be displayed in. If you enter a value here, it must be
in HEX format, or an error will occur. To see a list of available colors, see the
RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The settings in this parameter define the content and format
of label used on the Y axis of the bar chart.
Example: Status,arialbd.ttf,10,0x990000,%{label}
Result: Status
This defines the title that will be displayed next to the
values on the Y axis of the chart.
Examples: Percentage, Status, or Number of Units Sold
This defines the font used to display the Y axis label. To
see how you can change the font type, go to Font Properties.
This defines the size of the font used to display the Y axis
label. This field will be required if the Y Data Value Header Font Color (Setting
4) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the Y axis label will be
displayed in. If you enter a value here, it must be in HEX format, or an error
will occur. To see a list of available colors, go to the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This setting allows you to define the format of the data
labels provided on the Y axis of the bar chart. For instance, say you want to display
a percentage range from 1-100 (so the labels would be 20%-40%-60%-80%-100%). In
this example, you would use {value} %.
Example: {value}%, ${value}
To learn more about value substitution, see Substitution Properties.
This parameter is used to define the width and height of the
bar chart.
Example: 500,250
This setting allows you to change the width of the chart
display. While this doesn't control the width of the bar chart itself, it does
control the complete image width displayed to the user.
Examples: 500, or 400, or 300, or 350
This setting allows you to change the height of the chart
display. While this doesn't control the height of the bar chart itself, it does
control the complete height displayed to the user.
Examples: 250, or 100, or 500, or 325
The settings within this parameter allow you to alter the
location of the bar chart within the image.
Example: 40,80,400,250
This setting allows you to change the X coordinate location
of where the bar chart display will begin. If you choose to utilize an X Value
Data Header, you will need to leave room for this to be included in the image.
Examples: 250, or 300, or 125, or 400
This setting allows you to change the Y coordinate location
of where the bar chart display will begin. If you choose to have a Y Value Data
Header, you will need to leave room for this to be included in the image.
Examples: 125, or 150, or 175, or 200
This setting allows you to define the width of the bar chart
display within the image. If you take the total image width (defined in
Parameter 6) and subtract the “Bar Chart X Location” value, you should be able
to calculate this number to fill the remainder of the image width.
Examples: 125, or 150, or 175, or 200
This setting allows you to define the height of the bar chart
display within the image. If you take the total image height (defined in
Parameter 6) and subtract the “Bar Chart Y Location” value, you should be able
to calculate this number to fill the remainder of the image height.
Examples: 125, or 150, or 175, or 200
If this is set to true, the bar chart will present an
aggregate value at the end of the value bar. If this is set to false, no
aggregate text will be used.
Example: true
If this is set to true, all of the bar chart colors will be
faded by 20% to show a transparent effect. If set to false, all of the colors
will be opaque.
Example: true
When creating a bar chart, the highest value used is usually
where the bar chart X value or Y value will end. However, this may not be good
for you if, for example, you want to display a static number, a total count of
items, a sum of items, or the highest item. With this in mind, you can utilize
one of four different variables to create the desired result:
Value 1: Total Count of Items Returned for Each Filter - count (Example: count)
Value 2: Sum/Average/Count/Min/Max of Items Returned for Each Filter -
Sum(Field), Avg(Field), Count(Field), Min(Field), Max(Field) (Example:
Sum(Server Count))
Value 3: Highest Number Returned in Values Displayed - highest (Example:
highest)
Value 4: Static Number - number (Example: 100,000)
This setting allows you to change the format of the
Aggregate Value displayed at the end of each (?) bar in the bar chart. For
instance, if you wanted to display the Aggregate Value as a percentage, you
would use {value} %.
Example: {value}%, ${value}
If this is set to true, the bar chart will use its default
colors for separation. If set to false, either the default color of red will be
used, or a predefined color if one is set in the Chart Data text box.
Example: false
The Chart URL text box represents the Anchor Tag and Alt Tag
that are utilized in the image map that is created for the chart. The format
for the data within this text box is "parameter1;parameter2". For
example: "http://www.corasworks.net;title='Web Site Count {value}'
This parameter defines the URL the chart will link to when a
user clicks on a piece of data in the chart. “Use Relative URL” will not affect
this property.
This parameter
allows you to define the text that is displayed when an
individual moves their mouse over a chart and a link is displayed. You just
need to implement the proper variables within the title tag. As an example, title='${value}'
would return the data value with a $ symbol in front.
To learn more about Value Substitution see Substitution Properties.
NOTE: This topic
applies only to versions of the Chart Display Advanced web part from before the Summer 2005 release. If you
are working with Summer 2005 or a later release, please see “Admin:Display Tab”
instead.
CorasWorks utilizes a product called Chart Director to
maintain charts. Because of this, some portions of this help will mention the
Chart Director product. Chart Director creates each chart and the CorasWorks web
part then displays the chart to the user.
By default, these setting will be set up for a standard Task
list the first time you choose a chart.
The Chart Data text box is used to define the data and
formats used within the chart.
There are four
parameters that can be set
to be rendered into a Gantt chart. Unlike other chart types, only one group is
permitted. It starts with a
<Group> tag, indicating a new data stream.
Example:
Format: <Group>Parameter 1;Parameter2;Parameter3;Parameter4
Data: <Group>Title;Start Date;Due Date;0x990000
This parameter defines the name of the field that represents
the Title of each task.
Example: Title
This parameter defines the name of the field that represents
the Start Date. This must be a Date type field.
Examples: Start Date, Begin, or Created
This parameter defines the name of the field that represents
the End Date. This must be a Date type field.
Examples: Due Date, End, or Expires
This parameter defines the color in which each bar will be
displayed. If nothing is entered here, green will be utilized as the default
color. Any value entered here must in HEX format, or an error will occur. To
see a list of available colors, see the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The Chart Properties text box is used to define several properties
for the chart such as font color, header color, and so on. All parameters are
optional, but certain parameter settings may become required if the next setting
is entered.
Six chart property
parameters are available for Gantt charts. Each parameter is separated by a semicolon (;).
All settings within a parameter must be separated by a comma
(,). The comma signifies the next setting. If you choose not to define an
optional setting, it is not necessary to place any data between the first comma
and the next comma.
Format: P1-Setting1,P1-Setting2,P2-Setting3,P3-Setting4,P4-Setting5;P2-Setting1,P2-Setting2,P2-Setting3;P3-Setting1,P3-Setting2,P3-Setting3;P4-Setting1,P4-Setting2;P5-Setting1,P5-Setting2,P5-Setting3,P5-Setting4;P6
Example: Gantt
Chart,arialbd.ttf,10,0x000000,0xcc0000;arial.ttf,10,0xCC0000;arial.ttf,10,0x990000;500,250;40,80,400,250;14
The settings within this parameter define the content and
format of the chart title.
Example: Gantt Chart,arialbd.ttf,10,0x000000,0xcc0000
Result: Gantt Chart
This is the title that will be displayed at the top of the chart.
Examples: Gantt Chart, Outstanding Tasks, or Customer Satisfaction Levels
This defines the font used to display the chart title. To
see how you can change the font type, go to Font
Properties.
This defines the size of the font used to display the chart
title. This field is required if the Font Color (Setting 4) is defined.
Examples: 15, or 16, or 20, or 10
This defines the color that the Chart Title will be displayed
in. If you enter a value here, it must be in HEX format, or an error will
occur. To see a list of available colors, see the RGB Color
Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This defines the background color to be used behind the
Chart Title. If you enter a value here,
it must in HEX format, or an error will occur. To see a list of available colors,
see to the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The settings within this parameter are used to define the
font style, color, and type used for data on the X axis of the Gantt chart.
Example: arial.ttf,10,0xCC0000
Result: Task
Title
This will setting is used to define the font used to display
data values on the X axis of the Gantt chart. To see how you can change the font
type, go to Font Properties.
This setting is used to define the font size used to display
data values on the X axis of the Gantt chart.
This field is required if the Font Color (Setting 3) is defined.
Examples: 15, or 16, or 20, or 10
This defines the color that the data values on the X axis of
the Gantt chart will be displayed in. If you enter a value here, it must be in
HEX format, or an error will occur. To see a list of colors available colors,
see the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
The settings within this parameter are used to define the
font style, color, and type used for data on the Y axis of the Gantt
chart.
Example: arial.ttf,10,0x990000
Result: 1/1/2004
This is used to define the font used to display data values
on the Y axis of the bar chart. To see how you can change the font type, go to Font Properties.
This setting is used to define the font size used to display
data values on the Y axis of the Gantt chart. This field is required if the Y
Font Color (Setting 3) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the data values on the Y
axis of the Gantt chart will be displayed in. If you enter a value here, it must
be in HEX format, or an error will occur. To see a list of available colors,
see the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This parameter is used to define the width and height of the
Gantt chart.
Example: 500,250
This setting allows you to change the width of the chart
display. While this doesn't control the width of the Gantt chart itself, it
does control the complete image width displayed to the user.
Examples: 500, or 400, or 300, or 350
This setting allows you to change the height of the chart
display. While this doesn't control the height of the Gantt chart itself, it
does control the complete height displayed to the user.
Examples: 250, or 100, or 500, or 325
The settings within this parameter allow you to alter the
location of the Gantt chart within the image.
Example: 40,80,400,250
This setting allows you to change the X coordinate location
of where the Gantt chart display will begin. If you choose to utilize an X
Value Data Header, you will need to leave room for this to be included in the
image.
Examples: 250, or 300, or 125, or 400
This setting allows you to change the Y coordinate location
of where the Gantt chart display will begin. If you choose to have a Y Value
Data Header, you will need to leave room for this to be included in the image.
Examples: 125, or 150, or 175, or 200
This setting allows you to define the height of the Gantt chart
display within the image. If you take the total image height (defined in
Parameter 4) and subtract the “Gantt Chart Y Location” value, you should be
able to calculate this number to fill the remainder of the image height.
Examples: 125, or 150, or 175, or 200
This setting allow you to define the height of the Gantt chart
display within the image. If you take the total image height (defined in
Parameter 6) and subtract the “Gantt Chart Y Location” value, you should be
able to calculate this number to fill the remainder of the image height.
Examples: 125, or 150, or 175, or 200
By default, Gantt charts are designed to separate each line
by 7 days. If you would to increase or decrease this value, use this parameter
to define the number of days to separate each line with.
Example: 14
The Chart URL text box represents the Anchor Tag and Alt Tag
that are utilized in the image map that is created for the chart. The format
for the data within this text box is "parameter1;parameter2". For example:
"http://www.corasworks.net;title='Web Site Count {value}'.
This parameter defines the URL the chart will link to when a
user clicks on a piece of data in the chart. “Use Relative URL” will not affect
this property.
This parameter
allows you to define the text that is displayed when an
individual moves their mouse over a chart and a link is displayed. You just
need to implement the proper variables within the title tag. As an example, title='${value}'
would return the data value with a $ symbol in front.
To learn more about Value Substitution, see Substitution Properties.
NOTE: This topic
applies only to versions of the Chart Display Advanced web part from before the Summer 2005 release. If you
are working with Summer 2005 or a later release, please see “0Admin:Display TabHelp_D2HPrivate(-9,488)Admin:
Display Tab - Pie Charts0” instead.
CorasWorks utilizes a product called Chart Director to
maintain charts. Because of this, some portions of this help will mention the
Chart Director product. Chart Director creates each chart and the CorasWorks web
part then displays the chart to the user.
By default, any setting here will be set up for a standard
Task list the first time you choose a chart.
The Chart Data text box is used to define the data and
formats used within the chart.
There are five parameters that can be set to be rendered
into a pie chart. Each grouping of parameters is preceded by a <Group>
tag, indicating a new data stream.
[?
Flash]
Example: Two Items Returned [?
Flash]
Format: <Group>Parameter 1;Parameter2;Parameter3;Parameter4;Parameter5<Group>
Parameter 1;Parameter2;Parameter3;Parameter4;Parameter5
Data: <Group>Not Started;Count(Title);Status='Not
Started';0xCC0000;50<Group>In Progress;Count(Title);Status='In
Progress';0x000099;40
Parameter 1 - Data Title - String (Required) [? Flash]
This parameter defines the title to display for each data
element returned.
Examples: Not Started, In Progress, Completed
Parameter 2 - Data Type - String (Required) [? Flash]
This parameter defines the data type that will be returned.
You can have the data counted, summed up, or averaged, or just return the value
of a specific field. If you choose Average, Sum, or Return Value, the field
type must be Integer, otherwise no data will be returned. (Number and calculated
fields are integers.) If you choose Count, the total number of items returned
will be returned, which doesn't require the field to be of an integer type.
Notice in the example below that field names that include a
space or special character need to be placed within a "[" and
"]" in order to be recognized.
Examples: Count(Title), or Avg([% Complete]), or Sum([Parts Sold]), or [%
Complete]
Calculated fields are not supported.
Parameter 3 - Data Filter - String (Required) [? Flash]
This is the filter that is used to return the proper items
from the lists. This filter uses the same complex filter type as is used in the
"Filter" property for this web part. To learn more about filters, go
to Web Part Properties.
Examples: Status='Not Started', or [Assigned To] IS NOT NULL, or [Due
Date]>#[TODAY]#
Parameter 4 - Data Color - Hex RGB Value (Optional) [? Flash]
This parameter defines the color the data field will be
displayed in. Standard charts begin with red and end with yellow, but these colors
can be altered. If nothing is entered here, red will be utilized as the default
color. Any value entered here must in HEX format, otherwise an error will
occur. To see a list of available colors, refer to the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
Parameter 5 - Data Depth - Integer (Optional) - 3D Multi-Level Pie Only
[?
Flash]
This parameter defines the pixel depth in which each data element
will be represented in a 3D multi-level pie chart.
Examples: 10, 20, 22, or 35
The Chart Properties text box is used to define several
properties for the chart such as font color, header color, and so on. All parameters
are optional, but certain parameter settings may become required if the next
setting is entered.
Seven chart property
parameters are available for pie charts. Each parameter is separated by
a semicolon (;).
All settings within a parameter must be separated by a comma
(,). The comma signifies the next setting. If you choose not to define a value
for an optional setting, it is not necessary to place any data between the
first comma and the next comma.
Format: P1-Setting1,P1-Setting2,P1-Setting3,P1-Setting4,P1-Setting5;P2-Setting1,P2-Setting2,P2-Setting3;P3-Setting1,P3-Setting2;P4-Setting1,P4-Setting2,P4-Setting3;P5;P6;P7
Example: 2D Pie Chart,arialbd.ttf,10,0x000000,0xcc0000;arialbd.ttf,10,0x000000;500,250;250,125,75;true;true;false
The
settings within this parameter define the content and format of the chart
title.
Example: 2D Pie Chart,arialbd.ttf,10,0x000000,0xcc0000
Result: 2D Pie Chart
This is the title that will be displayed at the top of the
chart.
Examples: 2D Pie Chart, Status of Current Projects, or Customer Satisfaction
Levels
This
defines the font used to display the chart title. To see how you can change the
font type, go to Font Properties.
This defines the size of the font used to display the chart
title. This field is required if the Font Color (Setting 4) is defined.
Examples: 15, or 16, or 20, or 10
This defines the font color that the Chart Title will be
displayed in. If you enter a value here, it must in HEX format, or an error
will occur. To see a list of available colors, see the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This defines the background color to be used behind the
Chart Title. If you enter a value here,
it must in HEX format, or an error will occur. To see a list of available
colors, see the RGB Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
These
settings define the format of the data presented by the chart.
Example (arialbd.ttf,10,0x000000) In Progress
This setting defines the font used to present the data in
the chart. To see how you can change the font type, see Font Properties.
This defines the font size used to display the chart data.
This field will be required if the Font Color (Setting 3) is defined.
Examples: 15, or 16, or 20, or 10
This defines the color in which the chart data will be
displayed. If this is defined, it must be entered in HEX format, or an error
will occur. To see a list of available colors, see the RGB
Color Table.
Examples: 0xcc0000, or 0x990099, or 0x000000
This parameter is used to define the width and height of the
chart image.
Example: 500,250
This setting is used to change the width of the chart
display. While this doesn't control the width of the pie itself, it does
control the complete image width displayed to the user.
Examples: 500, or 400, or 300, or 350
This setting is used to change the height of the chart
display. While this doesn't control the height of the pie itself, it does
control the complete height displayed to the user.
Examples: 250, or 100, or 500, or 325
This allows you to alter the center location and radius of
the Pie Chart.
Example (250,125,75)
This setting allows you to change the X coordinate location
of the pie center. This is usually set to 1/2 of the total width of the image.
Examples: 250, or 300, or 125, or 400
This setting allows you to change the Y coordinate location
of the pie center. This is usually set to 1/2 of the total width of the image.
Examples: 125, or 150, or 175, or 200
This setting allows you to change the radius of the pie,
which in turn changes the complete width of the pie. The radius represents one
side of the pie, so it is reflected on the other sides as well.
Examples: 125, or 150, or 175, or 200
If this is set to true, the pie chart will utilize a side
bar configuration which presents all values on the side of the image and does
not permit any overlap. If set to false, all data values will be placed
directly next to the corresponding pie section.
Example: true
If this is set to true, all of the pie chart colors will be
faded by 20% to show a transparent effect. This is useful for the 3D
Multi-Level Pie Chart, as it allows you to see the many levels of the pie. If
set to false, all colors will be opaque.
Example: true
If this is set to true, the pie chart will use its default
colors for separation. If set to false, either the default color of red will be
used, or a pre-defined color if one is set in the Chart Data text box.
Example (false)
The Chart URL text box represents the Anchor Tag and Alt Tag
that are put in place for the image map that is created for the chart. The
format for the data within this text box is "parameter1;parameter2". For
example:
http://www.corasworks.net;title='Web Site Count {value}'
Parameter 1 (URL) - String (Optional) [? Flash]
This parameter defines the URL the chart will link to when a
user clicks on a piece of data in the chart. “Use Relative URL” will not affect
this property.
Parameter 2 (ALT Text Design) -
String (Optional) [? Flash]
This parameter
allows you to define the text that is displayed when an
individual moves their mouse over a chart and a link is displayed. You just
need to implement the proper variables within the title tag. As an example, title='${value}'
would return the data value with a $ symbol in front.
To learn more about Value Substitution, see Substitution Properties.
The following are a list of examples of charts created with
changes to the overall format in order to help you better understand the many
properties of the Chart Display Advanced Web Part.
|
||||||||
|
|
||||||||
|
|
||||||||
|
|
||||||||
|
|
||||||||
|
|
||||||||
|
|
||||||||
|
|
||||||||
|
NOTE: This
topic applies only to versions of the Chart Display Advanced web part from
before the Summer 2005 release. If you are working with Summer 2005 or a later
release, any fields that require color selection include a Color Picker.
The following is a list of colors currently supported by the
Charting Web Part Properties area. These colors can be introduced to change
text color, header background color, bar colors, and pie colors. Copy the HEX
value located below and place it into the property you wish to change. If you
wish to add a transparency effect to a color, introduce a "80" after
the "0x" and before the rest of the HEX Value. An example would be
"0x80CC0000". As you will notice, the values located after the
"0x" are the same values found within standard web page color
orientation. If you are using a color in your web site or see another color
used in another web site that you would like to use, copy their HEX value and
place a "0x" in front of the color text. An example would be the
color black - on a web part, it would be "000000" and for the
charting web part, it would be "0x000000".
EXAMPLE
|
|
|
|
|
Chart roll-ups support complex filtering,
which allows for SQL-like information queries. They can be comprised of any
number of fields and values. For example, you can build a filter that looks for
records that are not started, due within seven days, and have a high priority.
When defining complex filters, concatenation
is allowed using Boolean AND, OR, and NOT operators. You can use parentheses to
group clauses and force precedence. The AND operator has precedence over other
operators. For example:
(LastName = 'Smith' OR LastName =
'Jones') AND FirstName = 'John'
The following operators are allowed when
creating comparison complex filters:
· <
· >
· <=
· >=
· <>
· =
· IN
· LIKE
The following arithmetic operators are also
supported in complex filters:
· +
(addition)
· -
(subtraction)
· x
(multiplication)
· /
(division)
· %
(modulus)
Use the + character to concatenate a string.
Whether string comparisons are case-sensitive or not is determined by the value
of the DataSet class's CaseSensitive property. However, you can override that
value with the DataTable class's CaseSensitive property.
Both the * and % characters can be used
interchangeably as wildcards in a LIKE comparison. If the string in a LIKE
clause contains a * or %, those characters should be escaped in brackets ([]). If
a bracket is in the clause, the bracket characters should be escaped in
brackets (for example [[] or []]). A wildcard is allowed at the beginning of a
pattern, at the end of a pattern, or both. For example:
· ItemName
LIKE '*product*'
· ItemName
LIKE '*product'
· ItemName
LIKE 'product*'
Wildcards are not allowed in the middle of a
string. For example, 'te*xt' is not allowed.
The following aggregate types are supported:
· Sum
(Sum)
· Avg
(Average)
· Min
(Minimum)
· Max
(Maximum)
· Count
(Count)
· StDev
(Statistical standard deviation)
· Var
(Statistical variance).
When creating a complex filter, use the
Column Name to refer to columns. For example, if the Column Name for one column
is "UnitPrice" and another is "Quantity", the complex
filter would be: UnitPrice * Quantity
Also, enclose strings with single quotes: LastName = 'Jones'
The following characters are special
characters and must be escaped (wrapped in brackets) if they are used in a
column name, as explained below.
\n
(newline) |
+ |
\t
(tab) |
- |
\r
(carriage return) |
* |
~ |
% |
( |
& |
) |
| |
# |
^ |
\ |
' |
/ |
" |
= |
[ |
> |
] |
< |
|
If a column name contains one of the above
characters, the name must be wrapped in brackets. For example, to use a column
named Column# in a complex filter, you would reference the column as shown
here:
Total * [Column#]
Because brackets are special characters, you
must use a slash (\) to escape the bracket if it is part of a column name. For
example, a column named Column[] would be written:
Total * [Column[\]] (Only the second
bracket must be escaped.)
The same holds true if a column name
contains a space. For example, to use a column named First Name in a complex
filter, you would type the column name as shown here:
[First Name]='John'
User-defined values may be used within
complex filters and compared against column values. String values should be
enclosed within single quotes. Date values should be enclosed within pound
signs (#). Decimals and scientific notations are permissible for numeric
values. For example:
· FirstName
= 'John'
· Price
<= 50.00
· Birthdate
< #1/31/82#
For columns that contain enumeration values,
cast the value to an integer data type. For example:
EnumColumn = 5
If a column does not contain data, the use
of a column='' is not permissible and will not return the results that you are
looking for. Since the column row is empty, it will not respond with a String
result, but rather a NULL response. Because of this, you need to use the
"IS NULL" or "IS NOT NULL" request to see if a column
contains or does not contain any data. For example:
· [First
Name] IS NULL
· [First
Name] IS NOT NULL
CorasWorks utilizes a product called Chart Director to help maintain
charts. Chart Director creates the charts
and CorasWorks web parts display them to the user.
In ChartDirector, a font can be identified by specifying the
name of the file that contains the font. For example, under the Windows
platform, the Arial font is specified as "arial.ttf", while the Arial
Bold font is specified as "arialbd.ttf."
ChartDirector also supports several keywords that allow you
to identify the fonts indirectly. The actual font file name is looked up from a
font table based on the keywords. The keywords are as follows:
· normal
– The default normal font, which is the same as the first font in the font
table. ChartDirector will draw text using this font unless otherwise specified.
· bold
– The default bold font, which is the same as the second font in the font
table.
· italic
– The default italic font, which is the same as the third font in the font
table.
· boldItalic
– The default bold-italic font, which is the same as the fourth font in the
font table.
The default font table contains four fonts: arial.ttf normal,
arialbd.ttf for bold, ariali.ttf for italic and arialbi.ttf for bold and italic.
The advantages of using fonts in the font
table is that you can define and modify all fonts in your chart in one place.
ChartDirector does not come with any font files. It relies
on the operating system's font files in the "%systemroot%\Fonts"
directory, where %systemroot% is the operating system installation directory.
To see what fonts are installed in your operating system and their file names,
use the File Explorer to view that directory.
CorasWorks utilizes a product called Chart Director to
maintain charts. Because of this, some of portions of this help will mention
the Chart Director product. Chart Director creates each chart and the CorasWorks
web part then displays the chart to the user.
By default, these settings will be set up for a standard
Task list the first time you choose a chart.
ChartDirector uses parameter substitution to allow you to
configure precisely the information contained in the text and their format. For
example, when drawing a pie chart with side label layout, the default sector
label format is:
{label} ({percent}%)
In drawing the sector labels, ChartDirector will replace
"{label}" with the sector name, and "{percent}" with the
sector percentage. So the above label format will result is a sector label
similar to "ABC (34.56%)."
You can change the sector label format by changing the
format string. For example, you can change it to:
{label}: US${value}K ({percent}%)
The sector value will then become something like "ABC:
US$123 (35.56%)."
In general, in ChartDirector parameter substitution, fields
enclosed by curly brackets will be substituted with their actual values when
creating the texts.
ChartDirector supports parameter expressions. They are
fields enclosed by curly brackets and they start with the "="
character. For example:
USD {value} (Euro {={value}*0.9})
In the above example, "{value}" will be
substituted with the actual value of the sector. The expression "{={value}*0.9}"
will be substituted with the actual value of the sector multiplied by 0.9.
ChartDirector parameter expressions support operators
"+", "-", "*", "/" and "^"
(exponentiation). The *, /, and ^ operators are computed first, followed by +
and -. Operators of the same precedence are computed from left to right.
Parenthesis can be used to change the computation order.
For fields that are numbers or dates/times, ChartDirector
supports a special syntax in parameter substitution to allow these values to be
formatted. Please refer to the Number Formatting and Date/Time
Formatting sections below for details.
The following tables describe the fields available for
various chart objects.
Parameter |
Description |
sector |
The sector number. The first sector is 0, while the nth
sector is (n-1). |
dataSet |
Same as {sector}. See above. |
label |
The text label of the sector. |
dataSetName |
Same as {label}. See above. |
value |
The data value of the sector. |
percent |
The percentage value of the sector. |
field{N} |
The (N + 1)th extra field (the first extra field is
field0). |
The followings parameters apply to all XY chart layers in
general. Some layer types may have additional parameters (see below).
Note that certain parameters are inapplicable in some
contexts. For example, when specifying the aggregate label of a stacked bar
chart, the {dataSetName} parameter is inapplicable. This is because a stacked
bar is composed of multiple data sets. It does not belong to any particular
data set and hence does not have a data set name.
Parameter |
Description |
x |
The x value of the data point. For an enumerated x-axis,
the first data point is 0 and the nth data point is (n-1). |
xLabel |
The bottom x-axis label of the data point. |
x2Label |
The top x-axis label of the data point. |
value |
The value of the data point. |
percent |
The percentage of the data point based on the total value
of all data points. |
dataGroup |
The data group number to which the data point belongs. The
first data group is 0. The nth data group is (n-1). |
dataGroupName |
The name of the data group to which the data point
belongs. |
For parameters that are numeric, ChartDirector supports a
number of formatting options in parameter substitution.
For example, say you want a numeric field {value} to
have a precision of two digits to the right of the decimal point, use a comma as
the thousand separator and use a period as the decimal point. In this example,
you would use {value|2,.}. The number 123456.789 will then be
displayed as 123,456.79.
For numbers, the formatting options are specified using the
following syntax:
{[param]|[a][b][c][d]}
where:
Parameter |
Description |
[param] |
The name of the parameter |
[a] |
An integer specifying the number of digits to the right of
the decimal point. The default is automatic. To use the default, simply skip
this parameter. |
[b] |
The thousand separator. This should be a non-alphanumeric
character (not 0-9, A-Z, a-z). Use '~' for no thousand separator. The default
is '~', which can be modified using BaseChart.setNumberFormat. |
[c] |
The decimal point character. The default is '.', which can
be modified using BaseChart.setNumberFormat. |
[d] |
The negative sign character. Use '~' for no negative sign
character. The default is '-', which can be modified using
BaseChart.setNumberFormat. |
You may skip the trailing formatting options if they are
needed. For example, {value|2} means format the value with two digits to
the right, where the thousand separator, decimal point character, and negative
sign character all use the default settings of the chart.
For parameters that are dates/times, the formatting options
can be specified using the following syntax:
{[param]|[datetime_format_string]}
where [datetime_format_string] must start with an English
character (A-Z or a-z), and may contain any characters except '}'. Certain
characters are substituted according to the following table:
Parameter |
Description |
yyyy |
The year in 4 digits (e.g. 2002) |
yyy |
The year showing only the least significant 3 digits (e.g.
002 for the year 2002) |
yy |
The year showing only the least significant 2 digits (e.g.
02 for the year 2002) |
y |
The year showing only the least significant 1 digits (e.g.
2 for the year 2002) |
mmm |
The month formatted as its name. The default is to use the
first 3 characters of the English month name (Jan, Feb, Mar, etc.). The names
can be configured using BaseChart.setMonthNames. |
mm |
The month formatted as 2 digits from 01 - 12, adding a leading
zero if necessary. |
m |
The month formatted using the minimum number of digits
from 1 - 12. |
dd |
The day of month formatted as 2 digits from 01 - 31,
adding a leading zero if necessary. |
d |
The day of month formatted using the minimum number of
digits from 1 - 31. |
w |
The name of the day of week. The default is to use the
first 3 characters of the English day of week name (Sun, Mon, Tue, etc.). The
names can be configured using BaseChart.setWeekDayNames. |
hh |
The hour of day formatted as 2 digits, adding a leading
zero if necessary. The 2 digits will be 00 - 23 if the 'a' option (see below)
is not specified, otherwise it will be 00 - 12. |
h |
The hour of day formatted using the minimum number of
digits. The digits will be 0 - 23 if the 'a' option (see below) is not
specified, otherwise it will be 0 - 12. |
nn |
The minute formatted as 2 digits from 00 - 59, adding a leading
zero if necessary. |
n |
The minute formatted using the minimum number of digits
from 00 - 59. |
ss |
The second formatted as 2 digits from 00 - 59, adding a leading
zero if necessary. |
s |
The second formatted using the minimum number of digits
from 00 - 59. |
a |
Display either 'am' or 'pm,' depending on whether the time
is in the morning or afternoon. The 'am' and 'pm' text can be modified using
BaseChart.setAMPM. |
For example, a parameter substitution format of {value|mm-dd-yyyy}
will display a date as something similar to 09-15-2002. A format of {value|dd/mm/yy
hh:nn:ss a} will display a date as something similar to 15/09/02
03:04:05 pm.
The
Actions menu allows both administrators and users to execute common actions in
lieu of utilizing search commands. The Show Version action is available to all
users on the system.
To use
the Actions menu and view version information, go to the web part and drop down
the web part menu options by clicking on the down arrow on the top right hand
side of the web part. Drag your mouse
over "Actions" and then choose the desired option.
If
you are working with Summer 2005 or a later release, this option causes the
administration interface to be displayed. If you are working with a prior release,
this option causes the web part’s administration window to be displayed. In
either case, the resulting display allows administrators to determine the lists
and schemas utilized by the web part. This option is only available to administrators.
This
selection will show version information within the web part area, including application,
version, organization, authors, and build date. The link to Close Version
Window returns the page back to it original state.
NOTE: Because all CorasWorks web parts
utilize this command for version viewing, every CorasWorks web part on the page
will respond to the Show Version action. This will allow you to view version
information for all CorasWorks web parts at once.
CorasWorks
has built in a few commands so that certain actions can be activated directly
from the Search textbox in the web part, bypassing the need to access the web
part properties. These commands can be activated by typing the desired phrase
and clicking on the Search button.
This
will display the administration interface (Summer 05 and later releases) or the
administration window (previous releases) within the web part area, allowing
the administrator to define the sites and lists returned to the web part. This
option is only available to site collection and/or site/web administrators and
in shared view.
This
will hide the “Powered by CorasWorks” text located on the left side of the
search bar. To return this text to the display, enter the command again. This
option is only available to administrators. Keep in mind that since this
command is typed into the search bar, a search on the command text will also be
performed, so you will want to refresh the page after executing this command.
This
will refresh the current cache if caching is enabled. If Cache Per User is chosen,
this will only refresh the cache for the user activating this command. If the
opposite is true, the cache will be reset for all users.
This
will show the version window within the web part area to the user, allowing
them to view the application, version, organization, authors, and build date
of the web part. The Close Version Window link returns the page back to its
original state. No other users will see the version information; the version
information is actually displayed on a separate page with “?version=coras” at
the end of the URL.
NOTE: Because all CorasWorks web parts
utilize this as a means for viewing the version, all CorasWorks web parts on
the page will respond when this action is selected. This allows you to identify
all web parts created by CorasWorks, with the corresponding information.
This
will search throughout all the returned lists for items with the login name of
the individual executing the search. This command does not function for
anonymous users.
Connectability is a standard protocol that is supported
within a SharePoint environment. CorasWorks navigation and roll-up components
can utilize the connectability interface so CorasWorks web parts can “talk” to
one another and one web part can receive information from another web part.
This information can be used to alter the data displayed within the current web
part.
You can only activate a connection when the page is in
Design mode. Once in Design mode, access the web part menu and select
Connections. Then specify the type of connection you want and the web part you
want to connect to.
The three currently supported types of connections are List
Consumer, Row Consumer, and Cell Consumer.
This type of connection allows you to “consume” a list of
URLS from the Workplace View Advanced 3.5 (WVA) or the SPS Workplace View
Advanced 3.5 (SPS WVA). This allows you to set up your site information within
one web part and have its setting reflect within this web part. This type of
connection does not accept information from any other web part.
For example, imagine that there are multiple roll-up views
on a page. All of these roll-ups can be connected to the WVA. When you change
the sites and lists in the WVA, the roll-ups will update to show the
information selected. This reduces the time to reconfigure individual web parts
and ensures that they all have the correct configuration.
This type of connection allows you to consume a row of
information from within another web part. The connection filters against each
column displayed in the other web part.
The Row Filter performs a filter on the titles of the rows
collected form the other web part. This means that if the other web part
display includes Title and Due Date, your current list to be collected must
also contain the same row titles in order for the filter to function.
Row consumer connections that include fields with calculated
values are not supported.
This type of connection allows you to consume a specific
cell from within another web part. After a connection has been established, you
will be asked what cell you would like to read from the other web part. After
you have chosen a specific field (cell), the title of the column from the other
web part will be used to filter against by default. If you want to filter on a
different cell within your returned data, you can specify this within the
Connectable Properties section of the web part properties.
Cell consumer connections that include calculated values are
not supported.
As an example, imagine that you want to provide a
salesperson with information about a customer. You may want to create a page
that has contact information about the customer, order information, call
history, and support calls. Using connectability, you can connect the web parts
so that when you select a customer, the other views for orders, call history,
and support calls will automatically update to display that customer’s
information.
Because CorasWorks roll-ups can show information from any
sites or portal sub-areas, the data, such as the call history list or the
support calls, can be stored in different sites, such as departmental
sites. With connectability, you can
simply select a customer and all of the information for that customer is
displayed. This type of scenario would
also apply, for instance, in situations where you want to see information about
projects which are stored in sites for different departments. The key is that each list has to have a field
with the exact same name and the same data type, such as Customer ID or Project
ID.
CorasWorks web parts have a number of properties that can
only be modified by manually editing the DWP file associated with this web
part. You can edit a DWP file by exporting the web part to a location of your
choice, making the desired changes, and then uploading it back onto your site.
The properties described here allow you to change the
function and display of the web part. Please keep in mind the XML namespace of
the web part you are changing, or these properties will not be enabled within
the web part. XML namespaces for all
CorasWorks web parts are provided in the 1For
DevelopersHelp_D2HPrivate(-9,656)Overview1
help topic.
Also note that some of these properties some may require the
use of a "<", ">", or "&" symbol. If
that is the case, you will need to replace these characters with their encoded
equivalents of "<", ">", and
"&" respectively.
These properties are only viewable in the DWP if the default
settings have been changed.
NOTE: As of the
Summer 05 release of the Workplace Suite, a Localization tab on the
administration interface allows you to make many of the localization changes
described below. Before you make these changes in the DWP, you may want to
review the available settings that can be modified on the Localization tab.
This property allows you to alter the generic schema that
will be used by the web part. Currently "Announcements",
"Contacts", "Documents", "Events",
"Links", and "Tasks" are supported. Once this is changed
the generic schema that is stored in the DLL will be reset to utilize this
property. By default "Tasks" is utilized as the chart properties are
designed to support automatically this list type. This will be overridden if a
new List Schema has been added to the DWP.
Use: <ListType xmlns='webpart_namespace'>List Type</ListType>
Example: <ListType xmlns='CorasWSC.Chart.Display'>Tasks</ListType>
This property will allow you to change the web part’s default
MySite characteristics. By default, the web part will modify the URL
"/mysite" to point to "/personal/User". This allows the web
part to search through the MySite section of SharePoint Portal Server. SPS
allows the Administrator to alter the URL definition for each SPS server.
Because of this, the DWP Property "MySite" was designed to allow the
Administrator to alter the web part in order to support their specific SPS
MySite setup.
Use:<MySite
xmlns='webpart_namespace'>/site/<%Domain%> AND/OR
<%User%></MySite>
Example: <MySite xmlns='CorasWSC.Chart.Display'>/personal/<%User%></MySite>
Settings: <%User%> = UserName, <%Domain%> = Domain Name
This property allows you to start the collection of list
items for roll-up display one level above the site identified in the Site URL
field. This applies to Line of Site roll-ups only.
This property allows the "Powered By CorasWorks"
text to be hidden or shown at the top of the web part display. If this property
is set to true, the user will see the "Powered By CorasWorks" text. If
this property is set to false, the user will not see this text. This property
can be changed from true to false or from false to true by executing the proper
search command.
Use: <ShowCorasWorks xmlns='webpart_namespace'>true/false</ShowCorasWorks>
Example: <ShowCorasWorks
xmlns='CorasWSC.Chart.Display'>true</ShowCorasWorks>
This property allows the List Return Search Bar to be hidden
or shown. If this property is set to true, the user will see the List Return
Search Bar. If this property is set to false, the user will not be able to view
or use the List Return Search Bar. This property can be changed from true to
false by executing the proper search command. Once the property is set in the
search command, you can only return it to its original state by editing the
properties here.
Use: <ShowSearch xmlns='webpart_namespace'>true/false</ShowSearch>
Example: <ShowSearch
xmlns='CorasWSC.Chart.Display'>true</ShowSearch>
This Property toggles whether, after a cell consumer
connection has been established, the filter used will do so with a LIKE phrase
or a direct "=" phrase. By default, LIKE is used so that those lists
which contain choice or lookup fields will be relatively searched within.
Use: <UseLike xmlns='webpart_namespace'>true/false</UseLike>
Example: <UseLike xmlns='CorasWSC.Chart.Display'>true</UseLike>
CorasWorks web parts have a number of properties that can
only be modified by manually editing the DWP file associated with this web
part. The property described here applies specifically to document libraries.
You can edit a DWP file by exporting the web part to a location of your choice,
making the desired changes, and then uploading it back onto your site.
The properties described here allow you to change the
function and display of the web part. Please keep in mind the XML namespace of
the web part you are changing, or these properties will not be enabled within
the web part. XML namespaces for all
CorasWorks web parts are provided in the 2For
DevelopersHelp_D2HPrivate(-9,656)Overview2
help topic.
Also note that some of these properties some may require the
use of a "<", ">", or "&" symbol. If
that is the case, you will need to replace these characters with their encoded
equivalents of "<", ">", and
"&" respectively.
This property is only viewable in the DWP if the default
settings have been changed.
NOTE: As of the
Summer 05 release of the Workplace Suite, a Localization tab on the
administration interface allows you to make many of the localization changes
described below. Before you make these changes in the DWP, you may want to
review the available settings that can be modified on the Localization tab.
This property allows you to localize the user interface. The
easiest way to use this property is to follow these steps:
1. Copy the sample code below
into Notepad and make the appropriate translations to the content between each
tag.
2. Remove all of the carriage
returns and replace any double quotes (“) with single quotes (‘). Make sure
there aren’t any brackets ([ ]) anywhere in the text. If there are, replace
them with parentheses ( ). The XML nodes must appear in the exact order as they
are shown below; you can not omit nodes or reorder them.
3. Export the web part you want
to localize and add this: <LCIDXML xmlns="webpart_namespace"><![TA[]]></LCIDXML>
(where 'webpart_namespace' is the web part names identified in the .chm file
included in the Developer and Small Business editions of the Suite)
For example: <LCIDXML
xmlns="CorasWSC.Chart.Display"><![TA[]]></LCIDXML>
4. Copy the modified LCIDXML
content from Step 2 and place it after the opening bracket after TA.
5. Save the localized web part
and import it into your site. CorasWorks recommends that you use a naming
convention that makes it clear which language(s) are supported by the web part.
Sample Code:
<?xml version='1.0' ?>
<CorasWorks>
<RollUp id='default'>
<ReturnType>Return Type:</ReturnType>
<Administration>Administration</Administration>
<SiteUrl>Site URL:</SiteUrl>
<LevelsSearch>Levels Searched:</LevelsSearch>
<Schemas>Schema(s):</Schemas>
<AvailableLists>Available List(s):</AvailableLists>
<CurrentLists>Current List(s):</CurrentLists>
<CloseAdministration>Close
Administration</CloseAdministration>
<Status>Status:</Status>
<ReturnSitesList>Return Sites &
Lists</ReturnSitesList>
<Selective>Selective</Selective>
<LineofSite>Line of Site</LineofSite>
<UtilizeAllSChemas>Utilize All
Schemas:</UtilizeAllSChemas>
<SaveSelection>Save Selection</SaveSelection>
<SelectAllSiteLists>Select All Sites &
Lists</SelectAllSiteLists>
<RemoveAllSiteLists>Remove All Sites &
Lists</RemoveAllSiteLists>
<AddList>Add List</AddList>
<RemoveList>Remove List</RemoveList>
<SelectSearchCriteria>Select Search
Criteria</SelectSearchCriteria>
<Search>Search</Search>
<AddItem>Add Item</AddItem>
<NoItemsFound>No Items Found - Please Check Your Lists,
Filter, or Search Criteria</NoItemsFound>
<ExecuteSearch>Please Execute a Search to See
Results</ExecuteSearch>
<ShowAdmin>Show Admin</ShowAdmin>
<ShowVersion>Show Version</ShowVersion>
<Action>Actions</Action>
<ThisProcess>This Process Is Exceeding Its Time
Limitations</ThisProcess>
<ChartType>Chart Type:</ChartType>
<Charts>Charts</Charts>
<ThreeDPie>3D Pie</ThreeDPie>
<TwoDPie>2D Pie</TwoDPie>
<ThreeDMultiLevelPie>3D Multi-Level
Pie</ThreeDMultiLevelPie>
<TwoDHorChart>2D Hor. Chart</TwoDHorChart>
<ThreeDHorChart>3D Hor. Chart</ThreeDHorChart>
<TwoDVerChart>2D Ver. Chart</TwoDVerChart>
<ThreeDVerChart>3D Ver. Chart</ThreeDVerChart>
<Gannt>Gannt</Gannt>
<IncorrectSettings>Incorrect Settings in Chart Properties.
Please Check Your Settings and Try Again.</IncorrectSettings>
</RollUp>
</CorasWorks>
Note that the XML nodes must all appear on a single line, in
the exact order as they are displayed above. You can not omit nodes or reorder
them.
The CorasWorks node supports multiple RollUp nodes, allowing
for the same web part to be used on multiple sites. When the web part loads,
the language of the site that the web part is hosted in will automatically be
used, provided an ID attribute for the site’s RollUp node has
been defined, otherwise, the RollUp node with an attribute of
'default' will be used.
To localize the web part for multiple languages, repeat
these tags (and the content in between) for each language. However, instead of
using ‘default’ after the web part ID, use one of the 4-digit LCIDs provided
below. Copy the rest of the LCIDXML text and place it between these tags for
each desired language, making the appropriate translations for each language.
The following list shows the LCID for each language:
LCID Language
1025 Arabic
2052 Chinese - Simplified
1028 Chinese - Traditional
1029 Czech
1030 Danish
1043 Dutch
1033 English
1035 Finnish
1036 French
1031 German
1032 Greek
1037 Hebrew
1038 Hungarian
1040 Italian
1041 Japanese
1042 Korean
1044 Norwegian
1045 Polish
2070 Portuguese
1046 Portuguese – Brazilian
1049 Russian
1034 Spanish
1053 Swedish
1054 Thai
1055 Turkish
Schemas are what
allow roll-up web parts to access, understand, and display a list. They contain all of the elements that
identify the list: the list type, the fields to look for, the fields to display
and in what order, which fields can be used in a search or a filter, and the
percentage of the display that each column should take up.
The following
schemas are supported by CorasWorks Chart Display Advanced web parts out of the
box. If you have created your own schemas, they will not be available for
selection from this version of the web part; if you want to work with
additional schemas and you have either the Developer or Small Business edition
of the Workplace Suite, you can use the Roll-Up Wizard to create a modified
version of this web part that utilizes the additional schemas. This allows you
to create calendars from any type of list, library, or gallery that has a date
field.
NOTE: In order for a roll-up to work
correctly, each list that is referenced by the roll-up must contain the fields
named as “List Template Required Fields” below. Additional fields may be
included in the list, but the ones named in each schema below are required.
Display Fields:
Title (Main Field), Body
Search Fields: Title (Main Field), Body, Expires (DATE)
Filterable Fields: Title, Body, Expires (DATE)
Order By: Title, Body
List Template Type: Announcements
List Template Required Fields: Title (Main Field), Body, Expires (DATE)
Display Fields:
Title (Main Field), Body
Search Fields: Title (Main Field), Body, Expires (DATE), Publish
Filterable Fields: Title, Body, Expires (DATE), Publish
Order By: Title, Body
List Template Type: Announcements
List Template Required Fields: Title (Main Field), Body, Expires (DATE),
Publish
Display Fields:
Last Name (Main Field), First Name, Company, Email Address, Business Phone,
Search Fields: Last Name (Main Field), First Name, Company, Business Phone,
Email Address, City, State, Postal Code
Filterable Fields: Last Name, First Name, Company, Business Phone, Email
Address, City, State, Postal Code
Order By: Last Name, First Name, Company
List Template Type: Contacts
List Template Required Fields: Last Name (Main Field), First Name, Company,
Email Address, Business Phone, City, State, Postal Code
Display Fields:
Last Name (Main Field), First Name, Company, Email Address, Business Phone,
Search Fields: Last Name (Main Field), First Name, Company, Business Phone, Email
Address, City, State, Postal Code, Publish
Filterable Fields: Last Name, First Name, Company, Business Phone, Email
Address, City, State, Postal Code, Publish
Order By: Last Name, First Name, Company
List Template Type: Contacts
List Template Required Fields: Last Name (Main Field), First Name, Company,
Email Address, Business Phone, City, State, Postal Code, Publish
Display Fields:
Contact, Company (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Company (Main Field), Job Title, Business Phone, Email
Address, City, State, Type, Description
Filterable Fields: Contact, Company, Job Title, Business Phone, Email Address,
City, State, Type, Description
Order By: Contact, Company
List Template Type: Contacts
List Template Required Fields: Contact, Company (Main Field), Job Title,
Business Phone, Email Address, City, State, Type, Description
Display Fields:
Contact, Company (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Company (Main Field), Job Title, Business Phone, Email
Address, City, State, Type, Description, Publish
Filterable Fields: Contact, Company, Job Title, Business Phone, Email Address,
City, State, Type, Description, Publish
Order By: Contact, Company
List Template Type: Contacts
List Template Required Fields: Contact, Company (Main Field), Job Title,
Business Phone, Email Address, City, State, Type, Description, Publish
Display Fields:
Contact, Organization (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Organization (Main Field), Job Title, Business Phone,
Email Address, City, State, Type, Description
Filterable Fields: Contact, Organization, Job Title, Business Phone, Email Address,
City, State, Type, Description
Order By: Contact, Organization
List Template Type: Contacts
List Template Required Fields: Contact, Organization (Main Field), Job Title,
Business Phone, Email Address, City, State, Type, Description
Display Fields:
Contact, Organization (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Organization (Main Field), Job Title, Business Phone,
Email Address, City, State, Type, Description, Publish
Filterable Fields: Contact, Organization, Job Title, Business Phone, Email
Address, City, State, Type, Description, Publish
Order By: Contact, Organization
List Template Type: Contacts
List Template Required Fields: Contact, Organization (Main Field), Job Title,
Business Phone, Email Address, City, State, Type, Description, Publish
Display Fields:
Name (Main Field), Title
Search Fields: Name (Main Field), Title
Filterable Fields: Name, Title
Order By: Title, Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title
Display Fields:
Name (Main Field), Title
Search Fields: Name (Main Field), Title, Publish
Filterable Fields: Name, Title, Publish
Order By: Title, Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Publish
Display Fields:
Name (Main Field), Description, Date Released (DATE), Author
Search Fields: Name (Main Field), Description, Date Released (DATE), Author,
Remarks, Document Category, Expiration Date (DATE)
Filterable Fields: Name, Description, Date Released (DATE), Author, Remarks,
Document Category, Expiration Date (DATE)
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Description, Date Released
(DATE), Author, Remarks, Document Category, Expiration Date (DATE)
Display Fields:
Name (Main Field), Description, Date Released (DATE), Author
Search Fields: Name (Main Field), Description, Date Released (DATE), Author,
Remarks, Document Category, Expiration Date (DATE), Publish
Filterable Fields: Name, Description, Date Released (DATE), Author, Remarks,
Document Category, Expiration Date (DATE), Publish
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Description, Date Released
(DATE), Author, Remarks, Document Category, Expiration Date (DATE), Publish
Display Fields:
Name (Main Field), Description
Search Fields: Name (Main Field), Title, Description
Filterable Fields: Name, Title, Description
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Description
Display Fields:
Name (Main Field), Description
Search Fields: Name (Main Field), Title, Description, Publish
Filterable Fields: Name, Title, Description, Publish
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Description, Publish
Display Fields:
Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location,
Description
Filterable Fields: Title, Begin (DATE), End (DATE), Location, Description
Order By: Begin (DATE), End (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE),
Location, Description
Display Fields:
Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location,
Description, Publish
Filterable Fields: Title, Begin (DATE), End (DATE), Location, Description,
Publish
Order By: Begin (DATE), End (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE),
Location, Description, Publish
Display Fields:
Title (Main Field), Event Date (DATE), End Date (DATE)
Search Fields: Title (Main Field), Event Date (DATE), End Date (DATE), Location,
Description
Filterable Fields: Title, Event Date (DATE), End Date (DATE), Location,
Description
Order By: Event Date (DATE), End Date (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Event Date (DATE), End Date
(DATE), Location, Description
Display Fields:
Title (Main Field), Event Date (DATE), End Date (DATE)
Search Fields: Title (Main Field), Event Date (DATE), End Date (DATE),
Location, Description
Filterable Fields: Title, Event Date (DATE), End Date (DATE), Location,
Description
Order By: Event Date (DATE), End Date (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Event Date (DATE), End Date
(DATE), Location, Description, Publish
Display Fields: URL
(Main Field), Notes
Search Fields: URL (Main Field), Notes
Filterable Fields: URL, Notes
Order By: URL
List Template Type: Links
List Template Required Fields: URL (Main Field), Notes
Display Fields: URL
(Main Field), Notes
Search Fields: URL (Main Field), Notes, Publish
Filterable Fields: URL, Notes, Publish
Order By: URL
List Template Type: Links
List Template Required Fields: URL (Main Field), Notes, Publish
Display Fields: Title
(Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due
Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date
(DATE), % Complete, Due Date (DATE), Description
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), %
Complete, Due Date (DATE), Description
Order By: Title, Status
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status,
Priority, Start Date (DATE), % Complete, Due Date (DATE), Description
Display Fields:
Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), %
Complete, Due Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date
(DATE), % Complete, Due Date (DATE), Description, Publish
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), %
Complete, Due Date (DATE), Description, Publish
Order By: Title, Status
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status,
Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish
Display Fields:
Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), %
Complete, Due Date (DATE)
Search Fields: Title (Main Field), Manager, Project Status, Priority, Start
Date (DATE), % Complete, Due Date (DATE), Description
Filterable Fields: Title, Manager, Project Status, Priority, Start Date (DATE),
% Complete, Due Date (DATE), Description
Order By: Title, Project Status
List Template Type: Tasks
List Template Required Fields: Title, Manager, Project Status, Priority, Start
Date (DATE), % Complete, Due Date (DATE), Description
Display Fields:
Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), %
Complete, Due Date (DATE)
Search Fields: Title (Main Field), Manager, Project Status, Priority, Start
Date (DATE), % Complete, Due Date (DATE), Description, Publish
Filterable Fields: Title, Manager, Project Status, Priority, Start Date (DATE),
% Complete, Due Date (DATE), Description, Publish
Order By: Title, Project Status
List Template Type: Tasks
List Template Required Fields: Title, Manager, Project Status, Priority, Start
Date (DATE), % Complete, Due Date (DATE), Description, Publish
This is because you do not have the same rights as someone else.
Only those sites which you have access to will be presented to you.
This indicates that the URL you specified within the
"Status Properties" of the Web Part is incorrectly identified. Please
go into the Status Properties of the Web Part and correctly identify the site
you are trying to access. The format of the URL must be http://Site-URL or
http://Site-URL/Sub-Site-Name.
This indicates that the URL you specified within the
"Status Properties" of the Web Part is incorrectly identified. Please
go into the Status Properties of the Web Part and correctly identify the site
you are trying to access. The format of the URL must be http://Site-URL or
http://Site-URL/Sub-Site-Name.
This indicates that no lists have been found for the site
and levels chosen. Please make sure that you have access to the sites that you
would like to return contacts from and that you have entered a numerical value
into the "Levels Returned" text box.
This indicates that manual administration of the Shared Web
Part Property "Lists Being Return" was attempted. Please remove and
add the web part to the page and select the lists to be returned again.
This indicates that the search criteria, filter criteria is
incorrect, the user doesn't have access to the list(s) with information, the
list or site doesn't exist anymore, or there is no data within any of the lists
that have selected to be returned for the web part. To see if the search text
entered is incorrect select text from one of the lists search fields and enter
it within the search box to see if anything is returned. To see if the filter
criteria is incorrect choose a different filter field and search text to return
different information. Please make sure that your filter string is written as
"Field=SearchText". (Example: Postal Code=11111) If still nothing is
coming back check to make sure that the lists being returned have items within
them, that the list and site returned still exist, and the user has access to
them.
This can occur for several reasons;
1) The List must have all of the List Template Required Fields within one of
the List Templates Supported
2) The List must have been created utilizing the proper List Template.
If you create the a List via the Default List
Template of SharePoint, say Contacts, or a CorasWorks Generated
List like Updated Contacts, then it will be returned within the Web Part for
selection.
Does the list returned have to be
named the same as the Web Part? (I.e. Document Roll-Up Advanced - Documents)
No it does not. You must make sure that the List in question
was created with the proper List template and that the fields required are
within it. Outside of that you can name the list anything that you want.
The following updates have been made to CorasWorks Chart
Display Advanced Roll-Ups since they were initially introduced.
Resolved the following issues:
· Searching
and use of a data connection with parentheses (e.g., (1) High,
(2) Normal, etc.) are now both allowed
· Items
that have URL-type columns with a URL and a plus sign (+) are now correctly
displayed and linked
· When configured with Wait for Search, roll-up will return
data when the user clicks Next to bring back the next set of data, or when the
user clicks on a column to change the sort
· Added
Pie Radius to Display Tab for pie charts
· Added
administration interface
· Added
builders: Filter, chart data, chart property, localization, site URL
· Ability
to use calculated fields in filters
· Added
several date functions for filtering (CAML only)